net.openhft.chronicle.core.threads

Class CancellableTimer

java.lang.Object

net.openhft.chronicle.core.threads.CancellableTimer

public class CancellableTimer
extends Object

A timer that schedules tasks on an EventLoop. Execution is best-effort; missed times do not accumulate a backlog.

Example usage:

 try (Closeable c = timer.scheduleAtFixedRate(handler, 0L, 1000L)) {
     // work while the handler runs
 }
 

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 delay) Schedule eventHandler to run once after delay milliseconds.
Closeable	scheduleAtFixedRate(@NotNull VanillaEventHandler eventHandler, long initialDelay, long period) Schedules eventHandler for fixed-rate execution on the event loop.
Closeable	scheduleAtFixedRate(@NotNull VanillaEventHandler eventHandler, long initialDelay, long period, HandlerPriority priority) Schedules eventHandler for fixed-rate execution on the event loop.

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 initialDelay,
                                     long period)

Schedules eventHandler for fixed-rate execution on the event loop. Timing is best-effort; missed runs are not queued.

Parameters:

eventHandler - The handler to be invoked.

initialDelay - first wait in milliseconds before the handler runs.

period - interval in milliseconds between executions.

Returns:

A Closeable that when closed aborts future executions.

scheduleAtFixedRate

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

Schedules eventHandler for fixed-rate execution on the event loop. Timing is best-effort; missed runs are not queued.

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.

Returns:

A Closeable that when closed aborts future executions.

schedule

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

Schedule eventHandler to run once after delay milliseconds. After the task executes an InvalidEventHandlerException is thrown internally to remove it from the event loop.

Parameters:

eventHandler - The handler to be invoked once.

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

Returns:

A Closeable that when closed aborts future executions.