CompletableObserver that allows asynchronous cancellation of its subscription and associated resources.
All pre-implemented final methods are thread-safe.
Override the protected onStart() to perform initialization when this
ResourceCompletableObserver 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 onError() and onComplete() explicitly.
Use add(Disposable) to associate resources (as Disposables)
with this ResourceCompletableObserver 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
ResourceCompletableObserver and then add/remove resources to/from the CompositeDisposable
freely.
Like all other consumers, ResourceCompletableObserver 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(), onError(Throwable)
and onComplete() are not allowed to throw any unchecked exceptions.
Example
Disposable d =
Completable.complete().delay(1, TimeUnit.SECONDS)
.subscribeWith(new ResourceCompletableObserver() {
@Override public void onStart() {
add(Schedulers.single()
.scheduleDirect(() -> System.out.println("Time!"),
2, TimeUnit.SECONDS));
}
@Override public void onError(Throwable t) {
t.printStackTrace();
dispose();
}
@Override public void onComplete() {
System.out.println("Done!");
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 | add(@NonNull Disposable
the resource to add resource)Adds a resource to this |
| public final void | dispose()
Implements io. ResourceCompletableObserver (if any).
|
| public final boolean | Returns: true if thisResourceCompletableObserver has been disposed/cancelledImplements io. ResourceCompletableObserver has been disposed/cancelled.
|
| protected void | |
| public final void |
| 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. | |
| ResourceCompletableObserver | back to summary |
|---|---|
| public ResourceCompletableObserver() | |
| add | back to summary |
|---|---|
| public final void add(@NonNull Disposable resource) Adds a resource to this
| |
| dispose | back to summary |
|---|---|
| public final void dispose() Implements io. Cancels the main disposable (if any) and disposes the resources associated with
this This method can be called before the upstream calls
| |
| isDisposed | back to summary |
|---|---|
| public final boolean isDisposed() Implements io. Returns true if this
| |
| onStart | back to summary |
|---|---|
| protected void onStart() Called once the upstream sets a You can perform initialization at this moment. The default implementation does nothing. | |
| onSubscribe | back to summary |
|---|---|
public final void onSubscribe(@NonNull Disposable d)
| |