net.openhft.chronicle.core.threads

Class CancellableTimer

java.lang.Object

net.openhft.chronicle.core.threads.CancellableTimer

public class CancellableTimer
extends Object

A timer that can schedule tasks to be executed periodically or after a delay. The timer can be used to perform tasks in a non-blocking manner using an event loop.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	CancellableTimer.ScheduledEventHandler

Constructor Summary

Constructors

Constructor and Description
CancellableTimer(@NotNull EventLoop eventLoop) Constructs a CancellableTimer with the given event loop and system time provider.
CancellableTimer(@NotNull EventLoop eventLoop, @NotNull TimeProvider timeProvider) Constructs a CancellableTimer with the given event loop and custom time provider.

Method Summary

Modifier and Type	Method and Description
Closeable	schedule(@NotNull Runnable eventHandler, long initialDelayMs) Schedule a handler to run once after a delay
Closeable	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
Closeable	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

CancellableTimer

public CancellableTimer(@NotNull
                        @NotNull EventLoop eventLoop)

Constructs a CancellableTimer with the given event loop and system time provider.

Parameters:

eventLoop - the event loop that the timer tasks will run on.

CancellableTimer

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

Constructs a CancellableTimer with the given event loop and custom time provider.

Parameters:

eventLoop - the event loop that the timer tasks will run on.

timeProvider - the custom time provider to use for scheduling.

Method Detail

scheduleAtFixedRate

public Closeable 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

Returns:

a Closeable that when closed will abort any remaining scheduled calls

scheduleAtFixedRate

public Closeable 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

Returns:

a Closeable that when closed will abort any remaining scheduled calls

schedule

public Closeable 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

Returns:

a Closeable that when closed will abort any remaining scheduled calls