Package org.zeromq.timer
Class ZTimer
java.lang.Object
org.zeromq.timer.ZTimer
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 ClassesModifier and TypeClassDescriptionstatic final class
Opaque representation of a timer. -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionadd
(long interval, TimerHandler handler, Object... args) Add timer to the set, timer repeats forever, or until cancel is called.int
execute()
Execute the timers.int
Sleeps until at least one timer can be executed and execute the timers.long
timeout()
Returns the time in millisecond until the next timer.
-
Field Details
-
timer
-
-
Constructor Details
-
ZTimer
public ZTimer() -
ZTimer
-
-
Method Details
-
add
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.
-
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.
-
sleepAndExecute
public int sleepAndExecute()Sleeps until at least one timer can be executed and execute the timers.- Returns:
- the number of timers triggered.
-