Observer that allows asynchronous cancellation of its subscription and associated resources.
All pre-implemented final methods are thread-safe.
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 ResourceObserver 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
ResourceObserver and then add/remove resources to/from the CompositeDisposable
freely.
Use the dispose() to dispose the sequence from within an
onNext implementation.
Like all other consumers, ResourceObserver 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 =
Observable.range(1, 5)
.subscribeWith(new ResourceObserver<Integer>() {
@Override public void onStart() {
add(Schedulers.single()
.scheduleDirect(() -> System.out.println("Time!"),
2, TimeUnit.SECONDS));
request(1);
}
@Override public void onNext(Integer t) {
if (t == 3) {
dispose();
}
System.out.println(t);
}
@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 | |
| public final void | dispose()
Implements io. ResourceObserver (if any).
|
| public final boolean | Returns: true if thisResourceObserver has been disposed/cancelledImplements io. ResourceObserver 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. | |
| ResourceObserver | back to summary |
|---|---|
| public ResourceObserver() | |
| 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(Disposable d)
| |