DisposableSubscriber

Class Overview

An abstract Subscriber that allows asynchronous, external cancellation by implementing 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 onNext(Object). Make sure all initialization happens before the call to request() in onStart(). Calling request(long) inside 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(), onNext(Object), onError(Throwable) and onComplete() are not allowed to throw any unchecked exceptions. If for some reason this can't be avoided, use 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();
 

Summary

[Expand] Inherited Methods
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()
From interface io.reactivex.FlowableSubscriber abstract void onSubscribe(Subscription s) Implementors of this method should make sure everything that needs to be visible in onNext(Object) is established before calling request(long).
From interface io.reactivex.disposables.Disposable abstract void dispose() Dispose the resource, the operation should be idempotent. abstract boolean isDisposed() Returns true if this resource has been disposed.
From interface org.reactivestreams.Subscriber abstract void onComplete() abstract void onError(Throwable arg0) abstract void onNext(T arg0) abstract void onSubscribe(Subscription arg0)