net.openhft.chronicle.core.threads

Class Timer

java.lang.Object

net.openhft.chronicle.core.threads.Timer

public class Timer
extends Object

Timer class used to schedule tasks to be executed periodically or after a certain delay. The scheduling is performed on the provided event loop, and the execution time is best-effort. This means that if the event loop thread is busy, the execution of the scheduled task may be delayed.

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 initialDelayMs) Schedule a handler to run once after a delay
void	scheduleAtFixedRate(@NotNull VanillaEventHandler eventHandler, long initialDelayMs, long periodMs) uses the event loop thread to call the event handler periodically, the time that the event is called back is best-effort, but if the thread is busy that call back maybe delayed
void	scheduleAtFixedRate(@NotNull VanillaEventHandler eventHandler, long initialDelayMs, long periodMs, HandlerPriority priority) uses the event loop thread to call the event handler periodically, the time that the event is called back is best-effort, but if the thread is busy that call back maybe delayed

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 initialDelayMs,
                                long periodMs)

uses the event loop thread to call the event handler periodically, the time that the event is called back is best-effort, but if the thread is busy that call back maybe delayed

Parameters:

eventHandler - the handler to be called back

initialDelayMs - how long in milliseconds to wait before being called back

periodMs - the poll interval of being called

scheduleAtFixedRate

public void scheduleAtFixedRate(@NotNull
                                @NotNull VanillaEventHandler eventHandler,
                                long initialDelayMs,
                                long periodMs,
                                HandlerPriority priority)

uses the event loop thread to call the event handler periodically, the time that the event is called back is best-effort, but if the thread is busy that call back maybe delayed

Parameters:

eventHandler - the handler to be called back

initialDelayMs - how long in milliseconds to wait before being called back

periodMs - the poll interval of being called

priority - the priority of the event handler

schedule

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

Schedule a handler to run once after a delay

Parameters:

eventHandler - the handler to be called back

initialDelayMs - how long in milliseconds to wait before being called back