io.reactivex.subscribers

Class DisposableSubscriber<T>

java.lang.Object

io.reactivex.subscribers.DisposableSubscriber<T>

Type Parameters:

T - the received value type.

All Implemented Interfaces:

Disposable, org.reactivestreams.Subscriber<T>

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

An abstract Subscriber that allows asynchronous cancellation by implementing Disposable.

Constructor Summary

Constructors

Constructor and Description
DisposableSubscriber()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	cancel() Cancels the Subscription set via onSubscribe or makes sure a Subscription set asynchronously (later) is cancelled immediately.
void	dispose() Dispose the resource, the operation should be idempotent.
boolean	isDisposed() Returns true if this resource has been disposed.
protected void	onStart() Called once the single upstream Subscription is set via onSubscribe.
void	onSubscribe(org.reactivestreams.Subscription s)
protected void	request(long n) Requests the specified amount from the upstream if its Subscription is set via onSubscribe already.
protected org.reactivestreams.Subscription	subscription() Returns the current Subscription sent to this Subscriber via onSubscribe().

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

DisposableSubscriber

public DisposableSubscriber()

Method Detail

onSubscribe

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

Specified by:

onSubscribe in interface org.reactivestreams.Subscriber<T>

subscription

protected final org.reactivestreams.Subscription subscription()

Returns the current Subscription sent to this Subscriber via onSubscribe().

Returns:

the current Subscription, may be null

onStart

protected void onStart()

Called once the single upstream Subscription is set via onSubscribe.

request

protected final void request(long n)

Requests the specified amount from the upstream if its Subscription is set via onSubscribe already.

Note that calling this method before a Subscription is set via onSubscribe leads to NullPointerException and meant to be called from inside onStart or onNext.

Parameters:

n - the request amount, positive

cancel

protected final void cancel()

Cancels the Subscription set via onSubscribe or makes sure a Subscription set asynchronously (later) is cancelled immediately.

This method is thread-safe and can be exposed as a public API.

isDisposed

public final boolean isDisposed()

Description copied from interface: Disposable

Returns true if this resource has been disposed.

Specified by:

isDisposed in interface Disposable

Returns:

true if this resource has been disposed

dispose

public final void dispose()

Description copied from interface: Disposable

Dispose the resource, the operation should be idempotent.

Specified by:

dispose in interface Disposable