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 io.
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();
| Modifier and Type | Field and Description |
|---|---|
| pack-priv final AtomicReference |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| protected final void | cancel()
Cancels the Subscription set via onSubscribe or makes sure a Subscription set asynchronously (later) is cancelled immediately. |
| public final void | dispose()
Implements io. |
| public final boolean | isDisposed()
Implements io. |
| protected void | |
| public final void | onSubscribe(Subscription
the s)Subscription that allows requesting data via Subscription#request(long)Implements io. onNext(Object) is established before
calling Subscription#request(long).
|
| protected final void | request(long
the request amount, positive n)Requests the specified amount from the upstream if its Subscription is set via onSubscribe already. |
| upstream | back to summary |
|---|---|
| pack-priv final AtomicReference<Subscription> upstream | |
| DisposableSubscriber | back to summary |
|---|---|
| public DisposableSubscriber() | |
| cancel | back to summary |
|---|---|
| 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. | |
| dispose | back to summary |
|---|---|
| public final void dispose() Implements io. Doc from io. Dispose the resource, the operation should be idempotent.
| |
| isDisposed | back to summary |
|---|---|
| public final boolean isDisposed() Implements io. Doc from io. Returns true if this resource has been disposed.
| |
| onStart | back to summary |
|---|---|
| protected void onStart() Called once the single upstream Subscription is set via onSubscribe. | |
| onSubscribe | back to summary |
|---|---|
| public final void onSubscribe(Subscription s) Implements io. Doc from io. Implementors of this method should make sure everything that needs
to be visible in
No data will start flowing until
It is the responsibility of this
The
| |
| request | back to summary |
|---|---|
| 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.
| |