rx.plugins

Class RxJavaCompletableExecutionHook

java.lang.Object

rx.plugins.RxJavaCompletableExecutionHook

@Experimental
public abstract class RxJavaCompletableExecutionHook
extends java.lang.Object

Abstract ExecutionHook with invocations at different lifecycle points of Completable 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 completable so all behavior should be fast. If anything time-consuming is to be done it should be spawned asynchronously onto separate worker threads.

Since:

(if this graduates from Experimental/Beta to supported, replace this parenthetical with the release number)

Constructor Summary

Constructors

Constructor and Description
RxJavaCompletableExecutionHook()

Method Summary

Methods

Modifier and Type	Method and Description
Completable.CompletableOnSubscribe	onCreate(Completable.CompletableOnSubscribe f) Invoked during the construction by Completable.create(Completable.CompletableOnSubscribe)
Completable.CompletableOperator	onLift(Completable.CompletableOperator lift) Invoked just as the operator functions is called to bind two operations together into a new Completable and the return value is used as the lifted function
java.lang.Throwable	onSubscribeError(java.lang.Throwable e) Invoked after failed execution of Completable.subscribe(Subscriber) with thrown Throwable.
Completable.CompletableOnSubscribe	onSubscribeStart(Completable completableInstance, Completable.CompletableOnSubscribe onSubscribe) Invoked before Completable.subscribe(Subscriber) is about to be executed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RxJavaCompletableExecutionHook

public RxJavaCompletableExecutionHook()

Method Detail

onCreate

public Completable.CompletableOnSubscribe onCreate(Completable.CompletableOnSubscribe f)

Invoked during the construction by Completable.create(Completable.CompletableOnSubscribe)

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.

Parameters:

f - original Completable.CompletableOnSubscribe<T> to be executed

Returns:

Completable.CompletableOnSubscribe function that can be modified, decorated, replaced or just returned as a pass through

onSubscribeStart

public Completable.CompletableOnSubscribe onSubscribeStart(Completable completableInstance,
                                                  Completable.CompletableOnSubscribe onSubscribe)

Invoked before Completable.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.

Parameters:

completableInstance - the target completable instance

onSubscribe - original Completable.CompletableOnSubscribe<T> to be executed

Returns:

Completable.CompletableOnSubscribe<T> function that can be modified, decorated, replaced or just returned as a pass through

onSubscribeError

public java.lang.Throwable onSubscribeError(java.lang.Throwable e)

Invoked after failed execution of Completable.subscribe(Subscriber) with thrown Throwable.

This is not errors emitted via Observer.onError(Throwable) but exceptions thrown when attempting to subscribe to a Func1<Subscriber<T>, Subscription>.

Parameters:

e - Throwable thrown by Completable.subscribe(Subscriber)

Returns:

Throwable that can be decorated, replaced or just returned as a pass through

onLift

public Completable.CompletableOperator onLift(Completable.CompletableOperator lift)

Invoked just as the operator functions is called to bind two operations together into a new Completable and the return value is used as the lifted function

This can be used to decorate or replace the Completable.CompletableOperator instance or just perform extra logging, metrics and other such things and pass through the onSubscribe.

Parameters:

lift - original Completable.CompletableOperator<R, T>

Returns:

Completable.CompletableOperator<R, T> function that can be modified, decorated, replaced or just returned as a pass through