com.solacesystems.jcsmp.impl.timers.impl

Class JCSMPTimerQueueImpl

java.lang.Object

com.solacesystems.jcsmp.impl.timers.impl.JCSMPTimerQueueImpl

All Implemented Interfaces:

JCSMPTimerQueue

public class JCSMPTimerQueueImpl
extends Object
implements JCSMPTimerQueue

Constructor Summary

Constructors

Constructor and Description
JCSMPTimerQueueImpl()

Method Summary

Modifier and Type	Method and Description
void	cancelAllTimers() Cancel all scheduled timers.
void	cancelTimer(JCSMPTimer timer) Cancel a specific timer.
long	getTimeToNext(long curTime) Returns number of milliseconds to next timer expiry, or -1 if no timers are scheduled.
void	runAllTo(long targetTime) Runs all timers until targetTime.
JCSMPTimer	schedule_absolute(long time, JCSMPTimeoutHandler handler) Schedule a timer for an absolute time in the future.
JCSMPTimer	schedule_absolute(long time, 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)

Methods inherited from class java.lang.Object

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

Constructor Detail

JCSMPTimerQueueImpl

public JCSMPTimerQueueImpl()

Method Detail

getTimeToNext

public long getTimeToNext(long curTime)

Returns number of milliseconds to next timer expiry, or -1 if no timers are scheduled. Returned value will be 0 if a timer was due to expire in the past.

Parameters:

curTime - Time to use as current time.

Returns:

Milliseconds until the next scheduled timer.

runAllTo

public void runAllTo(long targetTime)

Runs all timers until targetTime. If two timers are scheduled for the same target time, the order in which they will run is indeterminate.

Parameters:

targetTime - Time to use as target.

cancelTimer

public void cancelTimer(JCSMPTimer timer)

Description copied from interface: JCSMPTimerQueue

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

Specified by:

cancelTimer in interface JCSMPTimerQueue

Parameters:

timer - Timer to cancel.

cancelAllTimers

public void cancelAllTimers()

Description copied from interface: JCSMPTimerQueue

Cancel all scheduled timers. (Warning - Dangerous!)

Specified by:

cancelAllTimers in interface JCSMPTimerQueue

schedule_relative

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

Specified by:

schedule_relative in interface JCSMPTimerQueue

schedule_absolute

public JCSMPTimer schedule_absolute(long time,
                                    JCSMPTimeoutHandler handler,
                                    JCSMPTimer timer)

Specified by:

schedule_absolute in interface JCSMPTimerQueue

schedule_relative

public JCSMPTimer schedule_relative(long offset,
                                    JCSMPTimeoutHandler handler)

Description copied from interface: JCSMPTimerQueue

Schedule a timer for a relative time in the future.

Specified by:

schedule_relative in interface JCSMPTimerQueue

Parameters:

offset - Relative time offset (milliseconds).

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

Returns:

result

schedule_absolute

public JCSMPTimer schedule_absolute(long time,
                                    JCSMPTimeoutHandler handler)

Description copied from interface: JCSMPTimerQueue

Schedule a timer for an absolute time in the future.

Specified by:

schedule_absolute in interface JCSMPTimerQueue

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