Package rx.plugins

Class RxJavaObservableExecutionHook

  • Direct Known Subclasses:
    RxJavaObservableExecutionHookDefault

    public abstract class RxJavaObservableExecutionHook
    extends java.lang.Object
    Abstract ExecutionHook with invocations at different lifecycle points of Observable 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 observable so all behavior should be fast. If anything time-consuming is to be done it should be spawned asynchronously onto separate worker threads.

    • Constructor Detail

      • RxJavaObservableExecutionHook

        public RxJavaObservableExecutionHook()
    • Method Detail

      • onSubscribeStart

        @Deprecated
        public <T> Observable.OnSubscribe<T> onSubscribeStart​(Observable<? extends T> observableInstance,
                                                              Observable.OnSubscribe<T> onSubscribe)
        Deprecated.
        Invoked before Observable.subscribe(rx.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
        Parameters:
        observableInstance - the parent observable instance
        onSubscribe - original Observable.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 of Observable.subscribe(rx.Subscriber) with returned Subscription.

        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
        Parameters:
        subscription - original Subscription
        Returns:
        Subscription subscription that can be modified, 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 new Observable and the return value is used as the lifted function

        This 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's value type (input)
        R - the downstream's value type (output)
        Parameters:
        lift - original Observable.Operator<R, T>
        Returns:
        Observable.Operator<R, T> function that can be modified, decorated, replaced or just returned as a pass through