SingleObserver that allows asynchronous cancellation of its subscription
and the associated resources.
All pre-implemented final methods are thread-safe.
Override the protected onStart() to perform initialization when this
ResourceSingleObserver is subscribed to a source.
Use the public dispose() method to dispose the sequence externally and release
all resources.
To release the associated resources, one has to call dispose()
in onSuccess() and onError() explicitly.
Use add(Disposable) to associate resources (as Disposables)
with this ResourceSingleObserver that will be cleaned up when dispose() is called.
Removing previously associated resources is not possible but one can create a
CompositeDisposable, associate it with this
ResourceSingleObserver and then add/remove resources to/from the CompositeDisposable
freely.
Like all other consumers, ResourceSingleObserver 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(), onSuccess(Object) and onError(Throwable)
are not allowed to throw any unchecked exceptions.
Example
Disposable d =
Single.just(1).delay(1, TimeUnit.SECONDS)
.subscribeWith(new ResourceSingleObserver<Integer>() {
@Override public void onStart() {
add(Schedulers.single()
.scheduleDirect(() -> System.out.println("Time!"),
2, TimeUnit.SECONDS));
}
@Override public void onSuccess(Integer t) {
System.out.println(t);
dispose();
}
@Override public void onError(Throwable t) {
t.printStackTrace();
dispose();
}
});
// ...
d.dispose();
| Modifier and Type | Field and Description |
|---|---|
| private final ListCompositeDisposable | resources
The resource composite, can never be null. |
| private final AtomicReference | upstream
The active subscription. |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public final void | |
| public final void | dispose()
Implements io. |
| public final boolean | Returns: true if this ResourceObserver has been disposed/cancelledImplements io. |
| protected void | |
| public final void | onSubscribe(Disposable
the Disposable instance whose d)Disposable#dispose() can
be called anytime to cancel the connectionImplements io. onSubscribe(Disposable) itself) and asynchronous manner.
|
| resources | back to summary |
|---|---|
| private final ListCompositeDisposable resources The resource composite, can never be null. | |
| upstream | back to summary |
|---|---|
| private final AtomicReference<Disposable> upstream The active subscription. | |
| ResourceSingleObserver | back to summary |
|---|---|
| public ResourceSingleObserver() | |
| add | back to summary |
|---|---|
| public final void add(Disposable resource) Adds a resource to this ResourceObserver.
| |
| dispose | back to summary |
|---|---|
| public final void dispose() Implements io. Cancels the main disposable (if any) and disposes the resources associated with this ResourceObserver (if any). This method can be called before the upstream calls onSubscribe at which case the main Disposable will be immediately disposed.
| |
| isDisposed | back to summary |
|---|---|
| public final boolean isDisposed() Implements io. Returns true if this ResourceObserver has been disposed/cancelled.
| |
| onStart | back to summary |
|---|---|
| protected void onStart() Called once the upstream sets a Subscription on this ResourceObserver. You can perform initialization at this moment. The default implementation does nothing. | |
| onSubscribe | back to summary |
|---|---|
| public final void onSubscribe(Disposable d) Implements io. Doc from io. Provides the SingleObserver with the means of cancelling (disposing) the
connection (channel) with the Single in both
synchronous (from within
| |