reactor.timer

Class HashWheelTimer

java.lang.Object

reactor.timer.HashWheelTimer

All Implemented Interfaces:

Timer

public class HashWheelTimer
extends java.lang.Object
implements Timer

Hash Wheel Timer, as per the paper: Hashed and hierarchical timing wheels: http://www.cs.columbia.edu/~nahum/w6998/papers/ton97-timing-wheels.pdf More comprehensive slides, explaining the paper can be found here: http://www.cse.wustl.edu/~cdgill/courses/cs6874/TimingWheels.ppt Hash Wheel timer is an approximated timer that allows performant execution of larger amount of tasks with better performance compared to traditional scheduling.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HashWheelTimer.BusySpinWait BusySpin wait strategy.
static class	HashWheelTimer.SleepWait Sleep wait strategy.
static class	HashWheelTimer.TimerRegistration<T extends Consumer<java.lang.Long>> Timer Registration
static interface	HashWheelTimer.WaitStrategy Wait strategy for the timer
static class	HashWheelTimer.YieldingWait Yielding wait strategy.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_WHEEL_SIZE

Constructor Summary

Constructors

Constructor and Description
HashWheelTimer() Create a new HashWheelTimer using the given with default resolution of 100 milliseconds and default wheel size.
HashWheelTimer(int resolution) Create a new HashWheelTimer using the given timer resolution.
HashWheelTimer(int res, int wheelSize, HashWheelTimer.WaitStrategy waitStrategy) Create a new HashWheelTimer using the given timer and .
HashWheelTimer(java.lang.String name, int res, int wheelSize, HashWheelTimer.WaitStrategy strategy, java.util.concurrent.Executor exec) Create a new HashWheelTimer using the given timer and .

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel current Timer
long	getResolution() Get the resolution of this tTimer.
HashWheelTimer.TimerRegistration<? extends Consumer<java.lang.Long>>	schedule(Consumer<java.lang.Long> consumer, long period, java.util.concurrent.TimeUnit timeUnit) Schedule a recurring task.
HashWheelTimer.TimerRegistration<? extends Consumer<java.lang.Long>>	schedule(Consumer<java.lang.Long> consumer, long period, java.util.concurrent.TimeUnit timeUnit, long delayInMilliseconds) Schedule a recurring task.
void	start() Start the Timer
HashWheelTimer.TimerRegistration<? 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.
HashWheelTimer.TimerRegistration<? extends Consumer<java.lang.Long>>	submit(Consumer<java.lang.Long> consumer, long period, java.util.concurrent.TimeUnit timeUnit) Submit a task for arbitrary execution after the given time delay.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_WHEEL_SIZE

public static final int DEFAULT_WHEEL_SIZE

See Also:

Constant Field Values

Constructor Detail

HashWheelTimer

public HashWheelTimer()

Create a new HashWheelTimer using the given with default resolution of 100 milliseconds and default wheel size.

HashWheelTimer

public HashWheelTimer(int resolution)

Create a new HashWheelTimer 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

HashWheelTimer

public HashWheelTimer(int res,
                      int wheelSize,
                      HashWheelTimer.WaitStrategy waitStrategy)

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

Parameters:

res - resolution of this timer in milliseconds

wheelSize - size of the Ring Buffer supporting the Timer, the larger the wheel, the less the lookup time is for sparse timeouts. Sane default is 512.

waitStrategy - strategy for waiting for the next tick

HashWheelTimer

public HashWheelTimer(java.lang.String name,
                      int res,
                      int wheelSize,
                      HashWheelTimer.WaitStrategy strategy,
                      java.util.concurrent.Executor exec)

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

Parameters:

name - name for daemon thread factory to be displayed

res - resolution of this timer in milliseconds

wheelSize - size of the Ring Buffer supporting the Timer, the larger the wheel, the less the lookup time is for sparse timeouts. Sane default is 512.

strategy - strategy for waiting for the next tick

exec - Executor instance to submit tasks to

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 HashWheelTimer.TimerRegistration<? 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.

submit

public HashWheelTimer.TimerRegistration<? extends Consumer<java.lang.Long>> submit(Consumer<java.lang.Long> consumer,
                                                                                   long period,
                                                                                   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

period - 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 HashWheelTimer.TimerRegistration<? 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

schedule

public HashWheelTimer.TimerRegistration<? 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)

start

public void start()

Start the Timer

cancel

public void cancel()

Cancel current Timer

Specified by:

cancel in interface Timer

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object