rx.android

Class MainThreadSubscription

java.lang.Object

rx.android.MainThreadSubscription

All Implemented Interfaces:

Subscription

public abstract class MainThreadSubscription
extends java.lang.Object
implements Subscription

A subscription which ensures its unsubscribe action is executed on the main thread. When unsubscription occurs on a different thread than the main thread, the action is posted to run on the main thread as soon as possible.

Instances of this class are useful in creating observables which interact with APIs that can only be used on the main thread, such as UI objects.

A convenience method is also provided for validating whether code is being called on the main thread. Calls to this method along with instances of this class are commonly used when creating custom observables using the following pattern:

 @Override public void call(Subscriber subscriber) {
   MainThreadSubscription.verifyMainThread();

   // TODO set up behavior

   subscriber.add(new MainThreadSubscription() {
     @Override public void onUnsubscribe() {
       // TODO undo behavior
     }
   });
 }
 

Constructor Summary

Constructors

Constructor and Description
MainThreadSubscription()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isUnsubscribed()
protected abstract void	onUnsubscribe()
void	unsubscribe()
static void	verifyMainThread() Verify that the calling thread is the Android main thread.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MainThreadSubscription

public MainThreadSubscription()

Method Detail

verifyMainThread

public static void verifyMainThread()

Verify that the calling thread is the Android main thread.

Calls to this method are usually preconditions for subscription behavior which instances of this class later undo. See the class documentation for an example.

Throws:

java.lang.IllegalStateException - when called from any other thread.

isUnsubscribed

public final boolean isUnsubscribed()

Specified by:

isUnsubscribed in interface Subscription

unsubscribe

public final void unsubscribe()

Specified by:

unsubscribe in interface Subscription

onUnsubscribe

protected abstract void onUnsubscribe()