net.openhft.chronicle.core.threads

Class Timer

java.lang.Object

net.openhft.chronicle.core.threads.Timer

public class Timer
extends Object

Timer schedules tasks on an EventLoop for best-effort execution. If the loop thread is busy the invocation is delayed but no backlog of missed runs is executed.

Constructor Summary

Constructors

Constructor and Description
Timer(@NotNull EventLoop eventLoop) Constructs a Timer with the default system time provider.
Timer(@NotNull EventLoop eventLoop, @NotNull TimeProvider timeProvider) Constructs a Timer with a specified time provider.

Method Summary

Modifier and Type	Method and Description
void	schedule(@NotNull Runnable eventHandler, long delay) Schedule eventHandler to run once after delay milliseconds.
void	scheduleAtFixedRate(@NotNull VanillaEventHandler eventHandler, long initialDelay, long period) Schedules eventHandler to run at a fixed-rate on the event loop.
void	scheduleAtFixedRate(@NotNull VanillaEventHandler eventHandler, long initialDelay, long period, HandlerPriority priority) Schedules eventHandler to run at a fixed-rate on the event loop.

Methods inherited from class java.lang.Object

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

Constructor Detail

Timer

public Timer(@NotNull
             @NotNull EventLoop eventLoop)

Constructs a Timer with the default system time provider.

Parameters:

eventLoop - The event loop on which the timer tasks are scheduled and run.

Timer

public Timer(@NotNull
             @NotNull EventLoop eventLoop,
             @NotNull
             @NotNull TimeProvider timeProvider)

Constructs a Timer with a specified time provider.

Parameters:

eventLoop - The event loop on which the timer tasks are scheduled and run.

timeProvider - The time provider used to control the scheduling.

Method Detail

scheduleAtFixedRate

public void scheduleAtFixedRate(@NotNull
                                @NotNull VanillaEventHandler eventHandler,
                                long initialDelay,
                                long period)

Schedules eventHandler to run at a fixed-rate on the event loop. Timing is best-effort and any delay does not trigger multiple catch-up invocations. The underlying call returns a Closeable; closing it aborts future executions.

Parameters:

eventHandler - The handler to be invoked.

initialDelay - first wait in milliseconds before the handler runs.

period - interval in milliseconds between executions.

scheduleAtFixedRate

public void scheduleAtFixedRate(@NotNull
                                @NotNull VanillaEventHandler eventHandler,
                                long initialDelay,
                                long period,
                                HandlerPriority priority)

Schedules eventHandler to run at a fixed-rate on the event loop. Timing is best-effort and any delay does not trigger multiple catch-up invocations. The underlying call returns a Closeable; closing it aborts future executions.

Parameters:

eventHandler - The handler to be invoked.

initialDelay - first wait in milliseconds before the handler runs.

period - interval in milliseconds between executions.

priority - The priority of the event handler.

schedule

public void schedule(@NotNull
                     @NotNull Runnable eventHandler,
                     long delay)

Schedule eventHandler to run once after delay milliseconds. Internally an InvalidEventHandlerException is thrown after the execution to remove the handler.

Parameters:

eventHandler - The handler to be invoked once.

delay - how long in milliseconds to wait before the handler runs.