ResourceObserver

Class Overview

An abstract 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 safeSubscribe(io.reactivex.Observer) 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();
 

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.Observer abstract void onComplete() Notifies the Observer that the Observable has finished sending push-based notifications. abstract void onError(Throwable e) Notifies the Observer that the Observable has experienced an error condition. abstract void onNext(T t) Provides the Observer with a new item to observe. abstract void onSubscribe(Disposable d) Provides the Observer with the means of cancelling (disposing) the connection (channel) with the Observable in both synchronous (from within onNext(Object)) and asynchronous manner.
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.