Package rx.schedulers

Class TestScheduler

java.lang.Object

rx.Scheduler

rx.schedulers.TestScheduler

public class TestScheduler
extends Scheduler

The TestScheduler is useful for debugging. It allows you to test schedules of events by manually advancing the clock at whatever pace you choose.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final class	TestScheduler.CompareActionsByTime
(package private) final class	TestScheduler.InnerTestScheduler
(package private) static final class	TestScheduler.TimedAction

Nested classes/interfaces inherited from class rx.Scheduler

Scheduler.Worker

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static long	counter
(package private) final Queue<TestScheduler.TimedAction>	queue
(package private) long	time

Constructor Summary

Constructors

Constructor	Description
TestScheduler()

Method Summary

Modifier and Type	Method	Description
void	advanceTimeBy(long delayTime, TimeUnit unit)	Moves the Scheduler's clock forward by a specified amount of time.
void	advanceTimeTo(long delayTime, TimeUnit unit)	Moves the Scheduler's clock to a particular moment in time.
Scheduler.Worker	createWorker()	Retrieves or creates a new Scheduler.Worker that represents serial execution of actions.
long	now()	Gets the current time, in milliseconds, according to this Scheduler.
void	triggerActions()	Triggers any actions that have not yet been triggered and that are scheduled to be triggered at or before this Scheduler's present time.
private void	triggerActions(long targetTimeInNanos)

Methods inherited from class rx.Scheduler

when

Methods inherited from class java.lang.Object

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

Field Details

queue

final Queue<TestScheduler.TimedAction> queue

counter

static long counter

time

long time

Constructor Details

TestScheduler

public TestScheduler()

Method Details

now

public long now()

Description copied from class: Scheduler

Gets the current time, in milliseconds, according to this Scheduler.

Overrides:

now in class Scheduler

Returns:

the scheduler's notion of current absolute time in milliseconds

advanceTimeBy

public void advanceTimeBy(long delayTime,
 TimeUnit unit)

Moves the Scheduler's clock forward by a specified amount of time.

Parameters:

delayTime - the amount of time to move the Scheduler's clock forward

unit - the units of time that delayTime is expressed in

advanceTimeTo

public void advanceTimeTo(long delayTime,
 TimeUnit unit)

Moves the Scheduler's clock to a particular moment in time.

Parameters:

delayTime - the point in time to move the Scheduler's clock to

unit - the units of time that delayTime is expressed in

triggerActions

public void triggerActions()

Triggers any actions that have not yet been triggered and that are scheduled to be triggered at or before this Scheduler's present time.

triggerActions

private void triggerActions(long targetTimeInNanos)

createWorker

public Scheduler.Worker createWorker()

Description copied from class: Scheduler

Retrieves or creates a new Scheduler.Worker that represents serial execution of actions.

When work is completed it should be unsubscribed using Subscription.unsubscribe().

Work on a Scheduler.Worker is guaranteed to be sequential.

Specified by:

createWorker in class Scheduler

Returns:

a Worker representing a serial queue of actions to be executed