Top Description Constructors Methods
rx.plugins

public abstract Class RxJavaCompletableExecutionHook

extends Object
Class Inheritance
Imports
rx.*, rx.functions.Func1
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
1.3

Constructor Summary

AccessConstructor and Description
public
RxJavaCompletableExecutionHook()

Method Summary

Modifier and TypeMethod and Description
public Completable.OnSubscribe

Returns:

rx.Completable.OnSubscribe function that can be modified, decorated, replaced or just returned as a pass through
onCreate(Completable.OnSubscribe
original rx.Completable.OnSubscribe<T> to be executed
f)

Deprecated
Invoked during the construction by Completable#create(Completable.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.

public Completable.Operator

Returns:

rx.Completable.Operator<R, T> function that can be modified, decorated, replaced or just returned as a pass through
onLift(final Completable.Operator
original rx.Completable.Operator<R, T>
lift)

Deprecated
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 rx.Completable.Operator instance or just perform extra logging, metrics and other such things and pass through the onSubscribe.

public Throwable

Returns:

Throwable that can be decorated, replaced or just returned as a pass through
onSubscribeError(Throwable
Throwable thrown by Completable#subscribe(Subscriber)
e)

Deprecated
Invoked after failed execution of Completable#subscribe(Subscriber) with thrown Throwable.
public Completable.OnSubscribe

Returns:

rx.Completable.OnSubscribe<T> function that can be modified, decorated, replaced or just returned as a pass through
onSubscribeStart(Completable
the target completable instance
completableInstance, final Completable.OnSubscribe
original rx.Completable.OnSubscribe<T> to be executed
onSubscribe)

Deprecated
Invoked before Completable#subscribe(Subscriber) is about to be executed.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

RxJavaCompletableExecutionHookback to summary
public RxJavaCompletableExecutionHook()

Method Detail

onCreateback to summary
public Completable.OnSubscribe onCreate(Completable.OnSubscribe f)

Deprecated

Invoked during the construction by Completable#create(Completable.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.

Parameters
f:Completable.OnSubscribe

original rx.Completable.OnSubscribe<T> to be executed

Returns:Completable.OnSubscribe

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

Annotations
@Deprecated
onLiftback to summary
public Completable.Operator onLift(final Completable.Operator lift)

Deprecated

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 rx.Completable.Operator instance or just perform extra logging, metrics and other such things and pass through the onSubscribe.

Parameters
lift:Completable.Operator

original rx.Completable.Operator<R, T>

Returns:Completable.Operator

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

Annotations
@Deprecated
onSubscribeErrorback to summary
public Throwable onSubscribeError(Throwable e)

Deprecated

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

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

Parameters
e:Throwable

Throwable thrown by Completable#subscribe(Subscriber)

Returns:Throwable

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

Annotations
@Deprecated
onSubscribeStartback to summary
public Completable.OnSubscribe onSubscribeStart(Completable completableInstance, final Completable.OnSubscribe onSubscribe)

Deprecated

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:Completable

the target completable instance

onSubscribe:Completable.OnSubscribe

original rx.Completable.OnSubscribe<T> to be executed

Returns:Completable.OnSubscribe

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

Annotations
@Deprecated