org.mobicents.servlet.sip.core.timers

Class ServletTimerImpl

java.lang.Object

org.mobicents.servlet.sip.core.timers.ServletTimerImpl

All Implemented Interfaces:

Runnable, ServletTimer, MobicentsServletTimer

public class ServletTimerImpl
extends Object
implements MobicentsServletTimer, Runnable

Constructor Summary

Constructors

Constructor and Description
ServletTimerImpl(Serializable info, long delay, boolean fixedDelay, long period, TimerListener listener, MobicentsSipApplicationSession appSession) Constructor for repeating times
ServletTimerImpl(Serializable info, long delay, TimerListener listener, MobicentsSipApplicationSession appSession) Constructor for non-repeating timer.

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel()
void	cancel(boolean mayInterruptIfRunning, boolean updateAppSessionReadyToInvalidateState) Cancel this timer, possibly by also interrupting the thread (from the thread pool) running the task.
boolean	canRun()
MobicentsSipApplicationSession	getApplicationSession()
long	getDelay() Getter for delay property.
String	getId()
Serializable	getInfo()
long	getPeriod() Getter for period property
long	getTimeRemaining()
boolean	isCanceled()
void	run() Method that actually
long	scheduledExecutionTime()
void	setApplicationSession(MobicentsSipApplicationSession sipApplicationSession)
void	setFuture(ScheduledFuture<?> f)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletTimerImpl

public ServletTimerImpl(Serializable info,
                long delay,
                TimerListener listener,
                MobicentsSipApplicationSession appSession)

Constructor for non-repeating timer.

Parameters:

info - Information about the timer

delay - Delay until execution

listener - Listener that will get timeout events.

ServletTimerImpl

public ServletTimerImpl(Serializable info,
                long delay,
                boolean fixedDelay,
                long period,
                TimerListener listener,
                MobicentsSipApplicationSession appSession)

Constructor for repeating times

Parameters:

info - Information about the timer

delay - Delay until first execution

fixedDelay - Whether fixed delay mode should be used

period - Period between execution

listener - Listener that will get timeout events.

Method Detail

cancel

public void cancel()

Specified by:

cancel in interface ServletTimer

cancel

public void cancel(boolean mayInterruptIfRunning,
          boolean updateAppSessionReadyToInvalidateState)

Cancel this timer, possibly by also interrupting the thread (from the thread pool) running the task. Note that interupting the thread may have undesired consequences.

Specified by:

cancel in interface MobicentsServletTimer

Parameters:

mayInterruptIfRunning -

updateAppSessionReadyToInvalidateState - boolean to update or not the readyToInvalidateState upon removing a servlet Timer, this is useful when we process a remoteInvalidation to make sure we don't load and update the sip session from the cache

getDelay

public long getDelay()

Getter for delay property.

Returns:

getPeriod

public long getPeriod()

Getter for period property

Returns:

getApplicationSession

public MobicentsSipApplicationSession getApplicationSession()

Specified by:

getApplicationSession in interface ServletTimer

setApplicationSession

public void setApplicationSession(MobicentsSipApplicationSession sipApplicationSession)

getInfo

public Serializable getInfo()

Specified by:

getInfo in interface ServletTimer

scheduledExecutionTime

public long scheduledExecutionTime()

Specified by:

scheduledExecutionTime in interface ServletTimer

setFuture

public void setFuture(ScheduledFuture<?> f)

canRun

public boolean canRun()

toString

public String toString()

Overrides:

toString in class Object

run

public void run()

Method that actually

Specified by:

run in interface Runnable

getId

public String getId()

Specified by:

getId in interface ServletTimer

getTimeRemaining

public long getTimeRemaining()

Specified by:

getTimeRemaining in interface ServletTimer

isCanceled

public boolean isCanceled()

Returns:

the isCanceled