io.aeron.cluster

Class WheelTimerServiceSupplier

java.lang.Object

io.aeron.cluster.WheelTimerServiceSupplier

All Implemented Interfaces:

TimerServiceSupplier

public class WheelTimerServiceSupplier
extends Object
implements TimerServiceSupplier

Supplies an instance of a WheelTimerService based on the configuration given to the constructor

Constructor Summary

Constructors

Constructor and Description
WheelTimerServiceSupplier(TimeUnit timeUnit, long startTime, long tickResolution, int ticksPerWheel) Construct the supplier with the necessary parameters to configure the timer wheel.

Method Summary

Modifier and Type	Method and Description
TimerService	newInstance(TimeUnit clusterTimeUnit, TimerService.TimerHandler timerHandler) New instance of the TimerService.

Methods inherited from class java.lang.Object

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

Constructor Detail

WheelTimerServiceSupplier

public WheelTimerServiceSupplier(TimeUnit timeUnit,
                                 long startTime,
                                 long tickResolution,
                                 int ticksPerWheel)

Construct the supplier with the necessary parameters to configure the timer wheel.

Parameters:

timeUnit - for the values used to express the time. This time unit is used to denote the supplied time values. When the instance is constructed it will use this to convert the supplied startTime and tickResolution into the time unit that is being used by the cluster clock.

startTime - for the wheel (in given TimeUnit).

tickResolution - for the wheel, i.e. how many TimeUnits per tick.

ticksPerWheel - or spokes, for the wheel (must be power of 2).

Method Detail

newInstance

public TimerService newInstance(TimeUnit clusterTimeUnit,
                                TimerService.TimerHandler timerHandler)

New instance of the TimerService.

Specified by:

newInstance in interface TimerServiceSupplier

Parameters:

clusterTimeUnit - units to be used by the underlying timer service.

timerHandler - that must be invoked for each expired timer.

Returns:

timer service instance ready for immediate usage.