Package rx.internal.schedulers

Class ScheduledAction

java.lang.Object

java.util.concurrent.atomic.AtomicReference<Thread>

rx.internal.schedulers.ScheduledAction

All Implemented Interfaces:

Serializable, Runnable, Subscription

public final class ScheduledAction
extends AtomicReference<Thread>
implements Runnable, Subscription

A Runnable that executes an Action0 and can be cancelled. The analog is the Subscriber in respect of an Observer.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) final class	ScheduledAction.FutureCompleter	Cancels the captured future if the caller of the call method is not the same as the runner of the outer ScheduledAction to prevent unnecessary self-interrupting if the unsubscription happens from the same thread.
(package private) static final class	ScheduledAction.Remover	Remove a child subscription from a composite when unsubscribing.
(package private) static final class	ScheduledAction.Remover2	Remove a child subscription from a composite when unsubscribing.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final Action0	action
(package private) final SubscriptionList	cancel
private static final long	serialVersionUID

Constructor Summary

Constructors

Constructor	Description
ScheduledAction(Action0 action)
ScheduledAction(Action0 action, SubscriptionList parent)
ScheduledAction(Action0 action, CompositeSubscription parent)

Method Summary

Modifier and Type	Method	Description
void	add(Future<?> f)	Adds the given Future to the unsubscription composite in order to support cancelling the underlying task in the executor framework.
void	add(Subscription s)	Adds a general Subscription to this ScheduledAction that will be unsubscribed if the underlying action completes or the this scheduled action is cancelled.
void	addParent(SubscriptionList parent)	Adds a parent CompositeSubscription to this ScheduledAction so when the action is cancelled or terminates, it can remove itself from this parent.
void	addParent(CompositeSubscription parent)	Adds a parent CompositeSubscription to this ScheduledAction so when the action is cancelled or terminates, it can remove itself from this parent.
boolean	isUnsubscribed()	Indicates whether this Subscription is currently unsubscribed.
void	run()
(package private) void	signalError(Throwable ie)
void	unsubscribe()	Stops the receipt of notifications on the Subscriber that was registered when this Subscription was received.

Methods inherited from class java.util.concurrent.atomic.AtomicReference

accumulateAndGet, compareAndExchange, compareAndExchangeAcquire, compareAndExchangeRelease, compareAndSet, get, getAcquire, getAndAccumulate, getAndSet, getAndUpdate, getOpaque, getPlain, lazySet, set, setOpaque, setPlain, setRelease, toString, updateAndGet, weakCompareAndSet, weakCompareAndSetAcquire, weakCompareAndSetPlain, weakCompareAndSetRelease, weakCompareAndSetVolatile

Methods inherited from class java.lang.Object

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

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

cancel

final SubscriptionList cancel

action

final Action0 action

Constructor Details

ScheduledAction

public ScheduledAction(Action0 action)

ScheduledAction

public ScheduledAction(Action0 action,
 CompositeSubscription parent)

ScheduledAction

public ScheduledAction(Action0 action,
 SubscriptionList parent)

Method Details

run

public void run()

Specified by:

run in interface Runnable

signalError

void signalError(Throwable ie)

isUnsubscribed

public boolean isUnsubscribed()

Description copied from interface: Subscription

Indicates whether this Subscription is currently unsubscribed.

Specified by:

isUnsubscribed in interface Subscription

Returns:

true if this Subscription is currently unsubscribed, false otherwise

unsubscribe

public void unsubscribe()

Description copied from interface: Subscription

Stops the receipt of notifications on the Subscriber that was registered when this Subscription was received.

This allows unregistering an Subscriber before it has finished receiving all events (i.e. before onCompleted is called).

Specified by:

unsubscribe in interface Subscription

add

public void add(Subscription s)

Adds a general Subscription to this ScheduledAction that will be unsubscribed if the underlying action completes or the this scheduled action is cancelled.

Parameters:

s - the Subscription to add

add

public void add(Future<?> f)

Adds the given Future to the unsubscription composite in order to support cancelling the underlying task in the executor framework.

Parameters:

f - the future to add

addParent

public void addParent(CompositeSubscription parent)

Adds a parent CompositeSubscription to this ScheduledAction so when the action is cancelled or terminates, it can remove itself from this parent.

Parameters:

parent - the parent CompositeSubscription to add

addParent

public void addParent(SubscriptionList parent)

Adds a parent CompositeSubscription to this ScheduledAction so when the action is cancelled or terminates, it can remove itself from this parent.

Parameters:

parent - the parent CompositeSubscription to add