reactor.timer

Interface Timer

All Known Implementing Classes:

HashWheelTimer, SimpleHashWheelTimer

public interface Timer

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel this timer by interrupting the task thread.
long	getResolution() Get the resolution of this tTimer.
Registration<? extends Consumer<java.lang.Long>>	schedule(Consumer<java.lang.Long> consumer, long period, java.util.concurrent.TimeUnit timeUnit) Schedule a recurring task.
Registration<? extends Consumer<java.lang.Long>>	schedule(Consumer<java.lang.Long> consumer, long period, java.util.concurrent.TimeUnit timeUnit, long delayInMilliseconds) Schedule a recurring task.
Registration<? extends Consumer<java.lang.Long>>	submit(Consumer<java.lang.Long> consumer) Submit a task for arbitrary execution after the delay of this timer's resolution.
Registration<? extends Consumer<java.lang.Long>>	submit(Consumer<java.lang.Long> consumer, long delay, java.util.concurrent.TimeUnit timeUnit) Submit a task for arbitrary execution after the given time delay.

Method Detail

getResolution

long getResolution()

Get the resolution of this tTimer.

Returns:

the resolution in milliseconds

schedule

Registration<? extends Consumer<java.lang.Long>> schedule(Consumer<java.lang.Long> consumer,
                                                          long period,
                                                          java.util.concurrent.TimeUnit timeUnit,
                                                          long delayInMilliseconds)

Schedule a recurring task. The given Consumer will be invoked once every N time units after the given delay.

Parameters:

consumer - the Consumer to invoke each period

period - the amount of time that should elapse between invocations of the given Consumer

timeUnit - the unit of time the period is to be measured in

delayInMilliseconds - a number of milliseconds in which to delay any execution of the given Consumer

Returns:

a Registration that can be used to cancel, pause or resume the given task.

schedule

Registration<? extends Consumer<java.lang.Long>> schedule(Consumer<java.lang.Long> consumer,
                                                          long period,
                                                          java.util.concurrent.TimeUnit timeUnit)

Schedule a recurring task. The given Consumer will be invoked immediately, as well as once every N time units.

Parameters:

consumer - the Consumer to invoke each period

period - the amount of time that should elapse between invocations of the given Consumer

timeUnit - the unit of time the period is to be measured in

Returns:

a Registration that can be used to cancel, pause or resume the given task.

See Also:

schedule(reactor.function.Consumer, long, java.util.concurrent.TimeUnit, long)

submit

Registration<? extends Consumer<java.lang.Long>> submit(Consumer<java.lang.Long> consumer,
                                                        long delay,
                                                        java.util.concurrent.TimeUnit timeUnit)

Submit a task for arbitrary execution after the given time delay.

Parameters:

consumer - the Consumer to invoke

delay - the amount of time that should elapse before invocations of the given Consumer

timeUnit - the unit of time the period is to be measured in

Returns:

a Registration that can be used to cancel, pause or resume the given task.

submit

Registration<? extends Consumer<java.lang.Long>> submit(Consumer<java.lang.Long> consumer)

Submit a task for arbitrary execution after the delay of this timer's resolution.

Parameters:

consumer - the Consumer to invoke

Returns:

this

cancel

void cancel()

Cancel this timer by interrupting the task thread. No more tasks can be submitted to this timer after cancellation.