Class TestScheduler

java.lang.Object

io.reactivex.rxjava4.core.Scheduler

io.reactivex.rxjava4.schedulers.TestScheduler

public final class TestScheduler
extends Scheduler

A special, non thread-safe scheduler for testing operators that require a scheduler without introducing real concurrency and allows manually advancing a virtual time.

By default, the tasks submitted via the various schedule methods are not wrapped by the RxJavaPlugins.onSchedule(Runnable) hook. To enable this behavior, create a TestScheduler via TestScheduler(boolean) or TestScheduler(long, TimeUnit, boolean).

Nested Class Summary

Nested classes/interfaces inherited from class Scheduler

Scheduler.Worker

Modifier and Type	Class	Description
static class	Scheduler.Worker	Represents an isolated, sequential worker of a parent Scheduler for executing Runnable tasks on an underlying task-execution scheme (such as custom Threads, event loop, Executor or Actor system).

Constructor Summary

Constructors

Constructor	Description
TestScheduler()	Creates a new TestScheduler with initial virtual time of zero.
TestScheduler(boolean useOnScheduleHook)	Creates a new TestScheduler with the option to use the RxJavaPlugins.onSchedule(Runnable) hook when scheduling tasks.
TestScheduler(long delayTime, TimeUnit unit)	Creates a new TestScheduler with the specified initial virtual time.
TestScheduler(long delayTime, TimeUnit unit, boolean useOnScheduleHook)	Creates a new TestScheduler with the specified initial virtual time and with the option to use the RxJavaPlugins.onSchedule(Runnable) hook when scheduling tasks.

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.
@NonNull Scheduler.Worker	createWorker()	Retrieves or creates a new Scheduler.Worker that represents sequential execution of actions.
long	now(@NonNull TimeUnit unit)	Returns the 'current time' of the Scheduler in the specified time unit.
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.

Methods inherited from class Scheduler

clockDriftTolerance, scheduleDirect, scheduleDirect, schedulePeriodicallyDirect, shutdown, start, toExecutorService, toExecutorService, when

Modifier and Type	Method	Description
static long	clockDriftTolerance()	Returns the clock drift tolerance in nanoseconds.
@NonNull Disposable	scheduleDirect(@NonNull Runnable run)	Schedules the given task on this Scheduler without any time delay.
@NonNull Disposable	scheduleDirect(@NonNull Runnable run, long delay, @NonNull TimeUnit unit)	Schedules the execution of the given task with the given time delay.
@NonNull Disposable	schedulePeriodicallyDirect(@NonNull Runnable run, long initialDelay, long period, @NonNull TimeUnit unit)	Schedules a periodic execution of the given task with the given initial time delay and repeat period.
void	shutdown()	Instructs the Scheduler instance to stop threads, stop accepting tasks on any outstanding Scheduler.Worker instances and clean up any associated resources with this Scheduler.
void	start()	Allows the Scheduler instance to start threads and accept tasks on them.
ExecutorService	toExecutorService()	Turn this Scheduler into an ExecutorService implementation using its various *Direct() methods instead of workers.
ExecutorService	toExecutorService(boolean useWorker)	Turn this Scheduler into an ExecutorService implementation using its various *Direct() methods or worker methods, depending on the parameter.
<S extends Scheduler & Disposable> S	when(@NonNull Function<Flowable<Flowable<Completable>>, Completable> combine)	Allows the use of operators for controlling the timing around when actions scheduled on workers are actually done.

Methods inherited from class Object

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

Constructor Details

TestScheduler

public TestScheduler()

Creates a new TestScheduler with initial virtual time of zero.

TestScheduler

public TestScheduler(boolean useOnScheduleHook)

Creates a new TestScheduler with the option to use the RxJavaPlugins.onSchedule(Runnable) hook when scheduling tasks.

History: 3.0.10 - experimental

Parameters:

useOnScheduleHook - if true, the tasks submitted to this TestScheduler is wrapped via the RxJavaPlugins.onSchedule(Runnable) hook

Since:

3.1.0

TestScheduler

public TestScheduler(long delayTime,
 TimeUnit unit)

Creates a new TestScheduler with the specified initial virtual time.

Parameters:

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

unit - the units of time that delayTime is expressed in

TestScheduler

public TestScheduler(long delayTime,
 TimeUnit unit,
 boolean useOnScheduleHook)

Creates a new TestScheduler with the specified initial virtual time and with the option to use the RxJavaPlugins.onSchedule(Runnable) hook when scheduling tasks.

History: 3.0.10 - experimental

Parameters:

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

unit - the units of time that delayTime is expressed in

useOnScheduleHook - if true, the tasks submitted to this TestScheduler is wrapped via the RxJavaPlugins.onSchedule(Runnable) hook

Since:

3.1.0

Method Details

now

public long now(@NonNull
 @NonNull TimeUnit unit)

Description copied from class: Scheduler

Returns the 'current time' of the Scheduler in the specified time unit.

Overrides:

now in class Scheduler

Parameters:

unit - the time unit

Returns:

the 'current time'

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.

createWorker

@NonNull
public @NonNull Scheduler.Worker createWorker()

Description copied from class: Scheduler

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

When work is completed, the Worker instance should be released by calling Disposable.dispose() to avoid potential resource leaks in the underlying task-execution scheme.

Work on a Scheduler.Worker is guaranteed to be sequential and non-overlapping.

Specified by:

createWorker in class Scheduler

Returns:

a Worker representing a serial queue of actions to be executed