gov.nist.javax.sip.stack.timers

Interface SipTimer

All Known Implementing Classes:

AffinitityExecutorSipTimer, DefaultSipTimer, ScheduledExecutorSipTimer

public interface SipTimer

Interface to implement to plug a new Timer implementation. currently the ones provided with the stack are based on java.util.Timer or java.util.concurrent.ScheduledThreadPoolExecutor

Author:

jean.deruelle@gmail.com

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cancel(SIPStackTimerTask task) cancel a previously scheduled task
boolean	isStarted() Check if the timer is started or stopped
boolean	schedule(SIPStackTimerTask task, long delay) Schedule a new SIPStackTimerTask after the specified delay
boolean	scheduleWithFixedDelay(SIPStackTimerTask task, long delay, long period) Schedule a new SIPStackTimerTask after the specified delay
void	start(SipStackImpl sipStack, Properties configurationProperties) Start the SIP Timer, called when the stack is created.
void	stop() Stop the Timer (called when the stack is stop or reinitialized)

Method Detail

schedule

boolean schedule(SIPStackTimerTask task,
               long delay)

Schedule a new SIPStackTimerTask after the specified delay

Parameters:

task - the task to schedule

delay - the delay in milliseconds to schedule the task

Returns:

true if the task was correctly scheduled, false otherwise

scheduleWithFixedDelay

boolean scheduleWithFixedDelay(SIPStackTimerTask task,
                             long delay,
                             long period)

Schedule a new SIPStackTimerTask after the specified delay

Parameters:

task - the task to schedule

delay - the delay in milliseconds to schedule the task

period - the period to run the task after it has been first scheduled

Returns:

true if the task was correctly scheduled, false otherwise

stop

void stop()

Stop the Timer (called when the stack is stop or reinitialized)

cancel

boolean cancel(SIPStackTimerTask task)

cancel a previously scheduled task

Parameters:

task - task to cancel

Returns:

true if the task was cancelled, false otherwise

start

void start(SipStackImpl sipStack,
         Properties configurationProperties)

Start the SIP Timer, called when the stack is created. The stack configuration is passed so that different implementations can use specific config properties to configure themselves

Parameters:

sipStack - TODO

configurationProperties - the stack properties

isStarted

boolean isStarted()

Check if the timer is started or stopped

Returns:

true is the timer is started false otherwise