Class DisposableSubscriber<T>
- java.lang.Object
-
- io.reactivex.rxjava3.subscribers.DisposableSubscriber<T>
-
- Type Parameters:
T
- the received value type.
- All Implemented Interfaces:
FlowableSubscriber<T>
,Disposable
,org.reactivestreams.Subscriber<T>
- Direct Known Subclasses:
BlockingFlowableLatest.LatestSubscriberIterator
,BlockingFlowableNext.NextSubscriber
,FlowableBufferExactBoundary.BufferBoundarySubscriber
,FlowableDebounce.DebounceSubscriber.DebounceInnerSubscriber
,FlowableWindowBoundary.WindowBoundaryInnerSubscriber
public abstract class DisposableSubscriber<T> extends java.lang.Object implements FlowableSubscriber<T>, Disposable
An abstract Subscriber that allows asynchronous, external cancellation by implementingDisposable
.All pre-implemented final methods are thread-safe.
The default
onStart()
requestsLong.MAX_VALUE
by default. Override the method to request a custom positive amount. Use the protectedrequest(long)
to request more items andcancel()
to cancel the sequence from within anonNext
implementation.Note that calling
request(long)
fromonStart()
may trigger an immediate, asynchronous emission of data toSubscriber.onNext(Object)
. Make sure all initialization happens before the call torequest()
inonStart()
. Callingrequest(long)
insideSubscriber.onNext(Object)
can happen at any time because by design,onNext
calls from upstream are non-reentrant and non-overlapping.Like all other consumers,
DisposableSubscriber
can be subscribed only once. Any subsequent attempt to subscribe it to a new source will yield anIllegalStateException
with message"It is not allowed to subscribe with a(n) <class name> multiple times."
.Implementation of
onStart()
,Subscriber.onNext(Object)
,Subscriber.onError(Throwable)
andSubscriber.onComplete()
are not allowed to throw any unchecked exceptions. If for some reason this can't be avoided, useFlowable.safeSubscribe(org.reactivestreams.Subscriber)
instead of the standardsubscribe()
method.Example
Disposable d = Flowable.range(1, 5) .subscribeWith(new DisposableSubscriber<Integer>() { @Override public void onStart() { request(1); } @Override public void onNext(Integer t) { if (t == 3) { cancel(); } System.out.println(t); request(1); } @Override public void onError(Throwable t) { t.printStackTrace(); } @Override public void onComplete() { System.out.println("Done!"); } }); // ... d.dispose();
-
-
Field Summary
Fields Modifier and Type Field Description (package private) java.util.concurrent.atomic.AtomicReference<org.reactivestreams.Subscription>
upstream
-
Constructor Summary
Constructors Constructor Description DisposableSubscriber()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
cancel()
Cancels the Subscription set viaonSubscribe(Subscription)
or makes sure aSubscription
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 upstreamSubscription
is set viaonSubscribe(Subscription)
.void
onSubscribe(org.reactivestreams.Subscription s)
Implementors of this method should make sure everything that needs to be visible inSubscriber.onNext(Object)
is established before callingSubscription.request(long)
.protected void
request(long n)
Requests the specified amount from the upstream if itsSubscription
is set via onSubscribe already.
-
-
-
Method Detail
-
onSubscribe
public final void onSubscribe(org.reactivestreams.Subscription s)
Description copied from interface:FlowableSubscriber
Implementors of this method should make sure everything that needs to be visible inSubscriber.onNext(Object)
is established before callingSubscription.request(long)
. In practice this means no initialization should happen after therequest()
call and additional behavior is thread safe in respect toonNext
.- Specified by:
onSubscribe
in interfaceFlowableSubscriber<T>
- Specified by:
onSubscribe
in interfaceorg.reactivestreams.Subscriber<T>
-
onStart
protected void onStart()
Called once the single upstreamSubscription
is set viaonSubscribe(Subscription)
.
-
request
protected final void request(long n)
Requests the specified amount from the upstream if itsSubscription
is set via onSubscribe already.Note that calling this method before a
Subscription
is set viaonSubscribe(Subscription)
leads toNullPointerException
and meant to be called from insideonStart()
orSubscriber.onNext(Object)
.- Parameters:
n
- the request amount, positive
-
cancel
protected final void cancel()
Cancels the Subscription set viaonSubscribe(Subscription)
or makes sure aSubscription
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 interfaceDisposable
- 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 interfaceDisposable
-
-