reactor.timer

Class SimpleHashWheelTimer

java.lang.Object

reactor.timer.SimpleHashWheelTimer

All Implemented Interfaces:

Timer

public class SimpleHashWheelTimer
extends java.lang.Object
implements Timer

A hashed wheel timer implementation that uses a Registry and custom Selectors to determine when tasks should be executed.

A SimpleHashWheelTimer has two variations for scheduling tasks: schedule(reactor.function.Consumer, long, java.util.concurrent.TimeUnit) and schedule(reactor.function.Consumer, long, java.util.concurrent.TimeUnit, long) which are for scheduling repeating tasks, and submit(reactor.function.Consumer, long, java.util.concurrent.TimeUnit) which is for scheduling single-run delayed tasks.

To schedule a repeating task, specify the period of time which should elapse before invoking the given Consumer. To schedule a task that repeats every 5 seconds, for example, one would do something like:

   SimpleHashWheelTimer timer = new SimpleHashWheelTimer();

   timer.schedule(new Consumer<Long>() {
     public void accept(Long now) {
       // run a task
     }
   }, 5, TimeUnit.SECONDS);
 

NOTE: Without delaying a task, it will be run immediately, in addition to being run after the elapsed time has expired. To run a task only once every N time units and not immediately, use the schedule(reactor.function.Consumer, long, java.util.concurrent.TimeUnit, long) method, which allows you to specify an additional delay that must expire before the task will be executed.

Constructor Summary

Constructors

Constructor and Description
SimpleHashWheelTimer() Create a new SimpleHashWheelTimer using the default resolution of 50ms.
SimpleHashWheelTimer(int resolution) Create a new SimpleHashWheelTimer using the given timer resolution.

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel this timer by interrupting the task thread.
long	getResolution() Get the resolution of this tTimer.
Registration<? extends Consumer<java.lang.Long>>	schedule(Consumer<java.lang.Long> consumer, long period, java.util.concurrent.TimeUnit timeUnit) Schedule a recurring task.
Registration<? extends Consumer<java.lang.Long>>	schedule(Consumer<java.lang.Long> consumer, long period, java.util.concurrent.TimeUnit timeUnit, long delayInMilliseconds) Schedule a recurring task.
Registration<? extends Consumer<java.lang.Long>>	submit(Consumer<java.lang.Long> consumer) Submit a task for arbitrary execution after the delay of this timer's resolution.
Registration<? extends Consumer<java.lang.Long>>	submit(Consumer<java.lang.Long> consumer, long delay, java.util.concurrent.TimeUnit timeUnit) Submit a task for arbitrary execution after the given time delay.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleHashWheelTimer

public SimpleHashWheelTimer()

Create a new SimpleHashWheelTimer using the default resolution of 50ms.

SimpleHashWheelTimer

public SimpleHashWheelTimer(int resolution)

Create a new SimpleHashWheelTimer using the given timer resolution. All times will rounded up to the closest multiple of this resolution.

Parameters:

resolution - the resolution of this timer, in milliseconds

Method Detail

getResolution

public long getResolution()

Description copied from interface: Timer

Get the resolution of this tTimer.

Specified by:

getResolution in interface Timer

Returns:

the resolution in milliseconds

schedule

public Registration<? extends Consumer<java.lang.Long>> schedule(Consumer<java.lang.Long> consumer,
                                                                 long period,
                                                                 java.util.concurrent.TimeUnit timeUnit,
                                                                 long delayInMilliseconds)

Description copied from interface: Timer

Schedule a recurring task. The given Consumer will be invoked once every N time units after the given delay.

Specified by:

schedule in interface Timer

Parameters:

consumer - the Consumer to invoke each period

period - the amount of time that should elapse between invocations of the given Consumer

timeUnit - the unit of time the period is to be measured in

delayInMilliseconds - a number of milliseconds in which to delay any execution of the given Consumer

Returns:

a Registration that can be used to cancel, pause or resume the given task.

schedule

public Registration<? extends Consumer<java.lang.Long>> schedule(Consumer<java.lang.Long> consumer,
                                                                 long period,
                                                                 java.util.concurrent.TimeUnit timeUnit)

Description copied from interface: Timer

Schedule a recurring task. The given Consumer will be invoked immediately, as well as once every N time units.

Specified by:

schedule in interface Timer

Parameters:

consumer - the Consumer to invoke each period

period - the amount of time that should elapse between invocations of the given Consumer

timeUnit - the unit of time the period is to be measured in

Returns:

a Registration that can be used to cancel, pause or resume the given task.

See Also:

Timer.schedule(reactor.function.Consumer, long, java.util.concurrent.TimeUnit, long)

submit

public Registration<? extends Consumer<java.lang.Long>> submit(Consumer<java.lang.Long> consumer,
                                                               long delay,
                                                               java.util.concurrent.TimeUnit timeUnit)

Description copied from interface: Timer

Submit a task for arbitrary execution after the given time delay.

Specified by:

submit in interface Timer

Parameters:

consumer - the Consumer to invoke

delay - the amount of time that should elapse before invocations of the given Consumer

timeUnit - the unit of time the period is to be measured in

Returns:

a Registration that can be used to cancel, pause or resume the given task.

submit

public Registration<? extends Consumer<java.lang.Long>> submit(Consumer<java.lang.Long> consumer)

Description copied from interface: Timer

Submit a task for arbitrary execution after the delay of this timer's resolution.

Specified by:

submit in interface Timer

Parameters:

consumer - the Consumer to invoke

Returns:

this

cancel

public void cancel()

Description copied from interface: Timer

Cancel this timer by interrupting the task thread. No more tasks can be submitted to this timer after cancellation.

Specified by:

cancel in interface Timer