Class RxJavaSingleExecutionHook
- java.lang.Object
-
- rx.plugins.RxJavaSingleExecutionHook
-
- Direct Known Subclasses:
RxJavaSingleExecutionHookDefault
public abstract class RxJavaSingleExecutionHook extends java.lang.Object
Abstract ExecutionHook with invocations at different lifecycle points ofSingle
execution with a default no-op implementation.See
RxJavaPlugins
or the RxJava GitHub Wiki for information on configuring plugins: https://github.com/ReactiveX/RxJava/wiki/Plugins.Note on thread-safety and performance:
A single implementation of this class will be used globally so methods on this class will be invoked concurrently from multiple threads so all functionality must be thread-safe.
Methods are also invoked synchronously and will add to execution time of the single so all behavior should be fast. If anything time-consuming is to be done it should be spawned asynchronously onto separate worker threads.
-
-
Constructor Summary
Constructors Constructor Description RxJavaSingleExecutionHook()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description <T> Single.OnSubscribe<T>
onCreate(Single.OnSubscribe<T> f)
Deprecated.<T,R>
Observable.Operator<? extends R,? super T>onLift(Observable.Operator<? extends R,? super T> lift)
Deprecated.<T> java.lang.Throwable
onSubscribeError(java.lang.Throwable e)
Deprecated.<T> Subscription
onSubscribeReturn(Subscription subscription)
Deprecated.<T> Observable.OnSubscribe<T>
onSubscribeStart(Single<? extends T> singleInstance, Observable.OnSubscribe<T> onSubscribe)
Deprecated.
-
-
-
Method Detail
-
onCreate
@Deprecated public <T> Single.OnSubscribe<T> onCreate(Single.OnSubscribe<T> f)
Deprecated.Invoked during the construction bySingle.create(Single.OnSubscribe)
This can be used to decorate or replace the
onSubscribe
function or just perform extra logging, metrics and other such things and pass through the function.- Type Parameters:
T
- the value type emitted by Single- Parameters:
f
- originalSingle.OnSubscribe
<T
> to be executed- Returns:
Single.OnSubscribe
<T
> function that can be modified, decorated, replaced or just returned as a pass through
-
onSubscribeStart
@Deprecated public <T> Observable.OnSubscribe<T> onSubscribeStart(Single<? extends T> singleInstance, Observable.OnSubscribe<T> onSubscribe)
Deprecated.Invoked beforeSingle.subscribe(Subscriber)
is about to be executed.This can be used to decorate or replace the
onSubscribe
function or just perform extra logging, metrics and other such things and pass through the function.- Type Parameters:
T
- the value type emitted- Parameters:
singleInstance
- the parent single instanceonSubscribe
- originalObservable.OnSubscribe
<T
> to be executed- Returns:
Observable.OnSubscribe
<T
> function that can be modified, decorated, replaced or just returned as a pass through
-
onSubscribeReturn
@Deprecated public <T> Subscription onSubscribeReturn(Subscription subscription)
Deprecated.Invoked after successful execution ofSingle.subscribe(Subscriber)
with returnedSubscription
.This can be used to decorate or replace the
Subscription
instance or just perform extra logging, metrics and other such things and pass through the subscription.- Type Parameters:
T
- the value type emitted by Single- Parameters:
subscription
- originalSubscription
- Returns:
Subscription
subscription that can be modified, decorated, replaced or just returned as a pass through
-
onSubscribeError
@Deprecated public <T> java.lang.Throwable onSubscribeError(java.lang.Throwable e)
Deprecated.Invoked after failed execution ofSingle.subscribe(Subscriber)
with thrown Throwable.This is not errors emitted via
Observer.onError(Throwable)
but exceptions thrown when attempting to subscribe to aFunc1
<Subscriber
<T>
,Subscription
>.- Type Parameters:
T
- the value type emitted by Single- Parameters:
e
- Throwable thrown bySingle.subscribe(Subscriber)
- Returns:
- Throwable that can be decorated, replaced or just returned as a pass through
-
onLift
@Deprecated public <T,R> Observable.Operator<? extends R,? super T> onLift(Observable.Operator<? extends R,? super T> lift)
Deprecated.Invoked just as the operator functions is called to bind two operations together into a newSingle
and the return value is used as the lifted functionThis can be used to decorate or replace the
Observable.Operator
instance or just perform extra logging, metrics and other such things and pass through the onSubscribe.- Type Parameters:
T
- the upstream value type (input)R
- the downstream value type (output)- Parameters:
lift
- originalObservable.Operator
<R, T>
- Returns:
Observable.Operator
<R, T>
function that can be modified, decorated, replaced or just returned as a pass through
-
-