com.solacesystems.jcsmp.impl.timers

Interface JCSMPTimerQueue

All Known Implementing Classes:

JCSMPTimerQueueImpl, SyncEventDispatcherReactor

public interface JCSMPTimerQueue

Timer Queue very loosely similar to ACE_Timer_Queue in the ACE framework. Allows synchronous dispatching of timeout events and fast scheduling and retrieval of timers.

Method Summary

Modifier and Type	Method and Description
void	cancelAllTimers() Cancel all scheduled timers.
void	cancelTimer(JCSMPTimer timer) Cancel a specific timer.
JCSMPTimer	schedule_absolute(long time, JCSMPTimeoutHandler handler) Schedule a timer for an absolute time in the future.
JCSMPTimer	schedule_absolute(long offset, JCSMPTimeoutHandler handler, JCSMPTimer timer)
JCSMPTimer	schedule_relative(long offset, JCSMPTimeoutHandler handler) Schedule a timer for a relative time in the future.
JCSMPTimer	schedule_relative(long offset, JCSMPTimeoutHandler handler, JCSMPTimer timer)

Method Detail

schedule_absolute

JCSMPTimer schedule_absolute(long time,
                             JCSMPTimeoutHandler handler)

Schedule a timer for an absolute time in the future.

Parameters:

time - Absolute time at which the timer should expire (same format as returned by System.currentTimeMillis()).

handler - Implementation of the JCSMPTimeoutHandler interface, to run on expiry.

Returns:

result

schedule_absolute

JCSMPTimer schedule_absolute(long offset,
                             JCSMPTimeoutHandler handler,
                             JCSMPTimer timer)

schedule_relative

JCSMPTimer schedule_relative(long offset,
                             JCSMPTimeoutHandler handler)

Schedule a timer for a relative time in the future.

Parameters:

offset - Relative time offset (milliseconds).

handler - Implementation of the JCSMPTimeoutHandler interface, to run on expiry.

Returns:

result

schedule_relative

JCSMPTimer schedule_relative(long offset,
                             JCSMPTimeoutHandler handler,
                             JCSMPTimer timer)

cancelTimer

void cancelTimer(JCSMPTimer timer)

Cancel a specific timer. It is legal to attempt to cancel a timer not currently scheduled; such a call has no effect.

Parameters:

timer - Timer to cancel.

cancelAllTimers

void cancelAllTimers()

Cancel all scheduled timers. (Warning - Dangerous!)