Class Timers

java.lang.Object

zmq.util.Timers

public final class Timers
extends Object

Manages set of timers. Timers can be added with a given interval, when the interval of time expires after addition, handler method is executed with given arguments. Timer is repetitive and will be executed over time until canceled. This is a DRAFT class, and may change without notice.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Timers.Handler
static final class	Timers.Timer

Field Summary

Fields

Modifier and Type	Field	Description
private final Supplier<Long>	clock
private final MultiMap<Long, Timers.Timer>	timers

Constructor Summary

Constructors

Constructor	Description
Timers()
Timers(Supplier<Long> clock)	Builds a new timer.

Method Summary

Modifier and Type	Method	Description
Timers.Timer	add(long interval, Timers.Handler handler, Object... args)	Add timer to the set, timer repeats forever, or until cancel is called.
boolean	cancel(Timers.Timer timer)	Deprecated. use Timers.Timer.cancel() instead
(package private) Iterable<Map.Entry<Timers.Timer, Long>>	entries()
int	execute()	Execute the timers.
private boolean	insert(Timers.Timer timer)
private long	now()
boolean	reset(Timers.Timer timer)	Deprecated. use Timers.Timer.reset() instead
boolean	setInterval(Timers.Timer timer, long interval)	Deprecated. use Timers.Timer.setInterval(long) instead
int	sleepAndExecute()
long	timeout()	Returns the time in millisecond until the next timer.

Methods inherited from class Object

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

Field Details

timers

private final MultiMap<Long, Timers.Timer> timers

clock

private final Supplier<Long> clock

Constructor Details

Timers

public Timers()

Timers

public Timers(Supplier<Long> clock)

Builds a new timer.

This constructor is for testing and is not intended to be used in production code.

Parameters:

clock - the supplier of the current time in milliseconds.

Method Details

now

private long now()

insert

private boolean insert(Timers.Timer timer)

add

public Timers.Timer add(long interval,
 Timers.Handler handler,
 Object... args)

Add timer to the set, timer repeats forever, or until cancel is called.

Parameters:

interval - the interval of repetition in milliseconds.

handler - the callback called at the expiration of the timer.

args - the optional arguments for the handler.

Returns:

an opaque handle for further cancel.

setInterval

@Deprecated
public boolean setInterval(Timers.Timer timer,
 long interval)

Deprecated.

use Timers.Timer.setInterval(long) instead

Changes the interval of the timer. This method is slow, canceling existing and adding a new timer yield better performance.

Parameters:

timer - the timer to change the interval to.

Returns:

true if set, otherwise false.

reset

@Deprecated
public boolean reset(Timers.Timer timer)

Deprecated.

use Timers.Timer.reset() instead

Reset the timer. This method is slow, canceling existing and adding a new timer yield better performance.

Parameters:

timer - the timer to reset.

Returns:

true if reset, otherwise false.

cancel

@Deprecated
public boolean cancel(Timers.Timer timer)

Deprecated.

use Timers.Timer.cancel() instead

Cancel a timer.

Parameters:

timer - the timer to cancel.

Returns:

true if cancelled, otherwise false.

timeout

public long timeout()

Returns the time in millisecond until the next timer.

Returns:

the time in millisecond until the next timer.

execute

public int execute()

Execute the timers.

Returns:

the number of timers triggered.

entries

Iterable<Map.Entry<Timers.Timer, Long>> entries()

sleepAndExecute

public int sleepAndExecute()