reactor.test.scheduler

Class VirtualTimeScheduler

java.lang.Object

reactor.test.scheduler.VirtualTimeScheduler

All Implemented Interfaces:

reactor.core.Cancellation, reactor.core.Disposable, reactor.core.scheduler.Scheduler, reactor.core.scheduler.TimedScheduler

public class VirtualTimeScheduler
extends Object
implements reactor.core.scheduler.TimedScheduler

A Scheduler that uses a virtual clock, allowing to manipulate time (eg. in tests). Can replace the default reactor schedulers by using the getOrSet(boolean) / set(VirtualTimeScheduler) methods.

Author:

Stephane Maldini

Nested Class Summary

Nested classes/interfaces inherited from interface reactor.core.scheduler.TimedScheduler

reactor.core.scheduler.TimedScheduler.TimedWorker

Nested classes/interfaces inherited from interface reactor.core.scheduler.Scheduler

reactor.core.scheduler.Scheduler.Worker

Field Summary

Fields inherited from interface reactor.core.scheduler.Scheduler

REJECTED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VirtualTimeScheduler()
protected	VirtualTimeScheduler(boolean allScheduler) Deprecated. will be removed in 3.1.0 in favor of an argumentless ctor (enable on all by default)

Method Summary

Modifier and Type	Method and Description
void	advanceTime() Triggers any tasks that have not yet been executed and that are scheduled to be executed at or before this VirtualTimeScheduler's present time.
void	advanceTimeBy(java.time.Duration delayTime) Moves the VirtualTimeScheduler's clock forward by a specified amount of time.
void	advanceTimeTo(java.time.Instant instant) Moves the VirtualTimeScheduler's clock to a particular moment in time.
static VirtualTimeScheduler	create() Deprecated. behavior will change to be that of createForAll() in 3.1.0
static VirtualTimeScheduler	createForAll() Deprecated. will be removed in 3.1.0, AT WHICH POINT the `create()` method will influence ALL schedulers
reactor.test.scheduler.VirtualTimeScheduler.VirtualTimeWorker	createWorker()
void	dispose()
static VirtualTimeScheduler	enable(boolean allSchedulers) Deprecated. use getOrSet(boolean) alias instead, will be removed in 3.1.0
static VirtualTimeScheduler	enable(VirtualTimeScheduler scheduler) Deprecated. use getOrSet(VirtualTimeScheduler) instead, will be removed in 3.1.0
static VirtualTimeScheduler	get() The current VirtualTimeScheduler assigned in Schedulers
static VirtualTimeScheduler	getOrSet() Assign a single newly created VirtualTimeScheduler to all Schedulers.Factory factories.
static VirtualTimeScheduler	getOrSet(boolean allSchedulers) Deprecated. will be removed in 3.1.0, use getOrSet() to obtain a newly created VTS and assign it to all factories
static VirtualTimeScheduler	getOrSet(VirtualTimeScheduler scheduler) Assign an externally created VirtualTimeScheduler to the relevant Schedulers.Factory factories, depending on how it was created (see createForAll() and create()).
boolean	isDisposed()
boolean	isEnabledOnAllSchedulers() Deprecated. will always be true from 3.1.0 onwards
static boolean	isFactoryEnabled() Return true if there is a VirtualTimeScheduler currently used by the Schedulers factory (ie it has been enabled), false otherwise (ie it has been reset).
long	now(TimeUnit unit)
static void	reset() Re-assign the default Reactor Core Schedulers factories.
reactor.core.Disposable	schedule(Runnable task)
reactor.core.Disposable	schedule(Runnable task, long delay, TimeUnit unit)
reactor.core.Disposable	schedulePeriodically(Runnable task, long initialDelay, long period, TimeUnit unit)
static VirtualTimeScheduler	set(VirtualTimeScheduler scheduler) Assign an externally created VirtualTimeScheduler to the relevant Schedulers.Factory factories, depending on how it was created (see createForAll() and create()).
void	shutdown()

Methods inherited from class java.lang.Object

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

Methods inherited from interface reactor.core.scheduler.Scheduler

start

Constructor Detail

VirtualTimeScheduler

@Deprecated
protected VirtualTimeScheduler(boolean allScheduler)

Deprecated. will be removed in 3.1.0 in favor of an argumentless ctor (enable on all by default)

VirtualTimeScheduler

protected VirtualTimeScheduler()

Method Detail

create

@Deprecated
public static VirtualTimeScheduler create()

Deprecated. behavior will change to be that of createForAll() in 3.1.0

Create a new VirtualTimeScheduler without enabling it. Call getOrSet(VirtualTimeScheduler) to enable it on timed-only Schedulers.Factory factories.

Returns:

a new VirtualTimeScheduler intended for timed-only Schedulers factories.

createForAll

@Deprecated
public static VirtualTimeScheduler createForAll()

Deprecated. will be removed in 3.1.0, AT WHICH POINT the `create()` method will influence ALL schedulers

Create a new VirtualTimeScheduler without enabling it. Call getOrSet(VirtualTimeScheduler) to enable it on all Schedulers.Factory factories.

Returns:

a new VirtualTimeScheduler intended for all Schedulers factories.

enable

@Deprecated
public static VirtualTimeScheduler enable(boolean allSchedulers)

Deprecated. use getOrSet(boolean) alias instead, will be removed in 3.1.0

Assign a single newly created VirtualTimeScheduler to all or timed-only Schedulers.Factory factories. While the method is thread safe, its usually advised to execute such wide-impact BEFORE all tested code runs (setup etc). The created scheduler is returned.

Parameters:

allSchedulers - true if all Schedulers.Factory factories

Returns:

the VirtualTimeScheduler that was created and set through the factory

enable

@Deprecated
public static VirtualTimeScheduler enable(VirtualTimeScheduler scheduler)

Deprecated. use getOrSet(VirtualTimeScheduler) instead, will be removed in 3.1.0

Assign an externally created VirtualTimeScheduler to the relevant Schedulers.Factory factories, depending on how it was created (see createForAll() and create()). Note that the returned scheduler should always be captured and used going forward, as the provided scheduler can be superseded by a matching scheduler that has already been enabled.

While the method is thread safe, it's usually advised to execute such wide-impact BEFORE all tested code runs (setup etc). The actual enabled Scheduler is returned.

Parameters:

scheduler - the VirtualTimeScheduler to use in factories.

Returns:

the enabled VirtualTimeScheduler (can be different from the provided one)

getOrSet

@Deprecated
public static VirtualTimeScheduler getOrSet(boolean allSchedulers)

Deprecated. will be removed in 3.1.0, use getOrSet() to obtain a newly created VTS and assign it to all factories

Assign a single newly created VirtualTimeScheduler to all or timed-only Schedulers.Factory factories. While the method is thread safe, its usually advised to execute such wide-impact BEFORE all tested code runs (setup etc). The created scheduler is returned.

Parameters:

allSchedulers - true if all Schedulers.Factory factories

Returns:

the VirtualTimeScheduler that was created and set through the factory

getOrSet

public static VirtualTimeScheduler getOrSet()

Assign a single newly created VirtualTimeScheduler to all Schedulers.Factory factories. While the method is thread safe, its usually advised to execute such wide-impact BEFORE all tested code runs (setup etc). The created scheduler is returned.

Returns:

the VirtualTimeScheduler that was created and set through the factory

getOrSet

public static VirtualTimeScheduler getOrSet(VirtualTimeScheduler scheduler)

Assign an externally created VirtualTimeScheduler to the relevant Schedulers.Factory factories, depending on how it was created (see createForAll() and create()). Note that the returned scheduler should always be captured and used going forward, as the provided scheduler can be superseded by a matching scheduler that has already been enabled.

While the method is thread safe, it's usually advised to execute such wide-impact BEFORE all tested code runs (setup etc). The actual enabled Scheduler is returned.

Parameters:

scheduler - the VirtualTimeScheduler to use in factories.

Returns:

the enabled VirtualTimeScheduler (can be different from the provided one)

set

public static VirtualTimeScheduler set(VirtualTimeScheduler scheduler)

Assign an externally created VirtualTimeScheduler to the relevant Schedulers.Factory factories, depending on how it was created (see createForAll() and create()). Contrary to getOrSet(VirtualTimeScheduler), the provided scheduler is always used, even if a matching scheduler is currently enabled.

While the method is thread safe, it's usually advised to execute such wide-impact BEFORE all tested code runs (setup etc).

Parameters:

scheduler - the VirtualTimeScheduler to use in factories.

Returns:

the enabled VirtualTimeScheduler (same as provided), for chaining

get

public static VirtualTimeScheduler get()

The current VirtualTimeScheduler assigned in Schedulers

Returns:

current VirtualTimeScheduler assigned in Schedulers

Throws:

IllegalStateException - if no VirtualTimeScheduler has been found

isFactoryEnabled

public static boolean isFactoryEnabled()

Return true if there is a VirtualTimeScheduler currently used by the Schedulers factory (ie it has been enabled), false otherwise (ie it has been reset).

reset

public static void reset()

Re-assign the default Reactor Core Schedulers factories. While the method is thread safe, its usually advised to execute such wide-impact AFTER all tested code has been run (teardown etc).

advanceTime

public void advanceTime()

Triggers any tasks that have not yet been executed and that are scheduled to be executed at or before this VirtualTimeScheduler's present time.

advanceTimeBy

public void advanceTimeBy(java.time.Duration delayTime)

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

Parameters:

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

advanceTimeTo

public void advanceTimeTo(java.time.Instant instant)

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

Parameters:

instant - the point in time to move the VirtualTimeScheduler's clock to

createWorker

public reactor.test.scheduler.VirtualTimeScheduler.VirtualTimeWorker createWorker()

Specified by:

createWorker in interface reactor.core.scheduler.Scheduler

Specified by:

createWorker in interface reactor.core.scheduler.TimedScheduler

isEnabledOnAllSchedulers

@Deprecated
public boolean isEnabledOnAllSchedulers()

Deprecated. will always be true from 3.1.0 onwards

Returns:

true if virtual-time is also enabled on non-timed global Schedulers.Factory

now

public long now(TimeUnit unit)

Specified by:

now in interface reactor.core.scheduler.Scheduler

schedule

public reactor.core.Disposable schedule(Runnable task)

Specified by:

schedule in interface reactor.core.scheduler.Scheduler

schedule

public reactor.core.Disposable schedule(Runnable task,
                                        long delay,
                                        TimeUnit unit)

Specified by:

schedule in interface reactor.core.scheduler.Scheduler

isDisposed

public boolean isDisposed()

Specified by:

isDisposed in interface reactor.core.Disposable

dispose

public void dispose()

Specified by:

dispose in interface reactor.core.Cancellation

Specified by:

dispose in interface reactor.core.Disposable

Specified by:

dispose in interface reactor.core.scheduler.Scheduler

shutdown

public void shutdown()

Specified by:

shutdown in interface reactor.core.scheduler.Scheduler

schedulePeriodically

public reactor.core.Disposable schedulePeriodically(Runnable task,
                                                    long initialDelay,
                                                    long period,
                                                    TimeUnit unit)

Specified by:

schedulePeriodically in interface reactor.core.scheduler.Scheduler