io.reactivex.subscribers

Class ResourceSubscriber<T>

java.lang.Object

io.reactivex.subscribers.ResourceSubscriber<T>

Type Parameters:

T - the value type

All Implemented Interfaces:

Disposable, org.reactivestreams.Subscriber<T>

public abstract class ResourceSubscriber<T>
extends java.lang.Object
implements org.reactivestreams.Subscriber<T>, Disposable

An abstract Subscriber that allows asynchronous cancellation of its subscription.

This implementation let's you chose if the AsyncObserver manages resources or not, thus saving memory on cases where there is no need for that.

All pre-implemented final methods are thread-safe.

Constructor Summary

Constructors

Constructor and Description
ResourceSubscriber()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Disposable resource) Adds a resource to this AsyncObserver.
protected void	cancel() Cancels the subscription (if any) and disposes the resources associated with this AsyncObserver (if any).
void	dispose() Dispose the resource, the operation should be idempotent.
boolean	isDisposed() Returns true if this AsyncObserver has been disposed/cancelled.
protected void	onStart() Called once the upstream sets a Subscription on this AsyncObserver.
void	onSubscribe(org.reactivestreams.Subscription s)
protected void	request(long n) Request the specified amount of elements from upstream.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.reactivestreams.Subscriber

onComplete, onError, onNext

Constructor Detail

ResourceSubscriber

public ResourceSubscriber()

Method Detail

add

public final void add(Disposable resource)

Adds a resource to this AsyncObserver.

Parameters:

resource - the resource to add

Throws:

java.lang.NullPointerException - if resource is null

onSubscribe

public final void onSubscribe(org.reactivestreams.Subscription s)

Specified by:

onSubscribe in interface org.reactivestreams.Subscriber<T>

onStart

protected void onStart()

Called once the upstream sets a Subscription on this AsyncObserver.

You can perform initialization at this moment. The default implementation requests Long.MAX_VALUE from upstream.

request

protected final void request(long n)

Request the specified amount of elements from upstream.

This method can be called before the upstream calls onSubscribe(). When the subscription happens, all missed requests are requested.

Parameters:

n - the request amount, must be positive

cancel

protected final void cancel()

Cancels the subscription (if any) and disposes the resources associated with this AsyncObserver (if any).

This method can be called before the upstream calls onSubscribe at which case the Subscription will be immediately cancelled.

dispose

public final void dispose()

Description copied from interface: Disposable

Dispose the resource, the operation should be idempotent.

Specified by:

dispose in interface Disposable

isDisposed

public final boolean isDisposed()

Returns true if this AsyncObserver has been disposed/cancelled.

Specified by:

isDisposed in interface Disposable

Returns:

true if this AsyncObserver has been disposed/cancelled