Class DisposableSubscriber<T>
- Type Parameters:
T- the received value type.
- All Implemented Interfaces:
FlowableSubscriber<T>, Disposable, Flow.Subscriber<T>
Disposable.
All pre-implemented final methods are thread-safe.
The default onStart() requests Long.MAX_VALUE by default. Override
the method to request a custom positive amount. Use the protected request(long)
to request more items and cancel() to cancel the sequence from within an
onNext implementation.
Note that calling request(long) from onStart() may trigger
an immediate, asynchronous emission of data to Flow.Subscriber.onNext(Object). Make sure
all initialization happens before the call to request() in onStart().
Calling request(long) inside Flow.Subscriber.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 an
IllegalStateException with message "It is not allowed to subscribe with a(n) <class name> multiple times.".
Implementation of onStart(), Flow.Subscriber.onNext(Object), Flow.Subscriber.onError(Throwable)
and Flow.Subscriber.onComplete() are not allowed to throw any unchecked exceptions.
If for some reason this can't be avoided, use Flowable.safeSubscribe(org.reactivestreams.Subscriber)
instead of the standard subscribe() 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();
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected final voidcancel()Cancels the Subscription set viaonSubscribe(Subscription)or makes sure aFlow.Subscriptionset asynchronously (later) is cancelled immediately.final voiddispose()Dispose the resource, the operation should be idempotent.final booleanReturns true if this resource has been disposed.protected voidonStart()Called once the single upstreamFlow.Subscriptionis set viaonSubscribe(Subscription).final voidImplementors of this method should make sure everything that needs to be visible inFlow.Subscriber.onNext(Object)is established before callingFlow.Subscription.request(long).protected final voidrequest(long n) Requests the specified amount from the upstream if itsFlow.Subscriptionis set via onSubscribe already.Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface Flow.Subscriber
onComplete, onError, onNext
-
Constructor Details
-
DisposableSubscriber
public DisposableSubscriber()
-
-
Method Details
-
onSubscribe
Description copied from interface:FlowableSubscriberImplementors of this method should make sure everything that needs to be visible inFlow.Subscriber.onNext(Object)is established before callingFlow.Subscription.request(long). In practice this means no initialization should happen after therequest()call and additional behavior is thread safe in respect toonNext.- Specified by:
onSubscribein interfaceFlow.Subscriber<T>- Specified by:
onSubscribein interfaceFlowableSubscriber<T>
-
onStart
protected void onStart()Called once the single upstreamFlow.Subscriptionis set viaonSubscribe(Subscription). -
request
protected final void request(long n) Requests the specified amount from the upstream if itsFlow.Subscriptionis set via onSubscribe already.Note that calling this method before a
Flow.Subscriptionis set viaonSubscribe(Subscription)leads toNullPointerExceptionand meant to be called from insideonStart()orFlow.Subscriber.onNext(Object).- Parameters:
n- the request amount, positive
-
cancel
protected final void cancel()Cancels the Subscription set viaonSubscribe(Subscription)or makes sure aFlow.Subscriptionset 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:DisposableReturns true if this resource has been disposed.- Specified by:
isDisposedin interfaceDisposable- Returns:
- true if this resource has been disposed
-
dispose
public final void dispose()Description copied from interface:DisposableDispose the resource, the operation should be idempotent.- Specified by:
disposein interfaceDisposable
-