flex.messaging.util
Class TimeoutAbstractObject

java.lang.Object
  flex.messaging.util.TimeoutAbstractObject

All Implemented Interfaces:

TimeoutCapable

Direct Known Subclasses:

FlexClient, FlexSession, MessageClient

public abstract class TimeoutAbstractObject
extends Object
implements TimeoutCapable

This class defines the default implementation of TimeoutCapable, providing the default behavior for an object that is capable of timing out where that time out mechanism is managed by TimeoutManager.

Constructor Summary

TimeoutAbstractObject()

Method Summary

void	cancelTimeout() Revoke the timeout task, removing it from future evaluation and execution.
long	getLastUse() Determine the timestamp of this object's last use, where "last use" should denote all tasks that eliminate idleness.
edu.emory.mathcs.backport.java.util.concurrent.Future	getTimeoutFuture()
TimeoutManager	getTimeoutManager()
long	getTimeoutPeriod() Determine the time, in milliseconds, that this object is allowed to idle before having its timeout method invoked.
Runnable	getTimeoutTask()
void	setLastUse(long lastUse)
void	setTimeoutFuture(edu.emory.mathcs.backport.java.util.concurrent.Future timeoutFuture) Set the Future used to provide access to the Runnable task that invokes the timeout method.
void	setTimeoutManager(TimeoutManager timeoutManager)
void	setTimeoutPeriod(long timeoutPeriod)
void	setTimeoutTask(Runnable timeoutTask)
void	updateLastUse()

Methods inherited from class java.lang.Object

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

Methods inherited from interface flex.messaging.util.TimeoutCapable

timeout

Constructor Detail

TimeoutAbstractObject

public TimeoutAbstractObject()

Method Detail

cancelTimeout

public void cancelTimeout()

Description copied from interface: TimeoutCapable

Revoke the timeout task, removing it from future evaluation and execution.

Specified by:

cancelTimeout in interface TimeoutCapable

getLastUse

public long getLastUse()

Description copied from interface: TimeoutCapable

Determine the timestamp of this object's last use, where "last use" should denote all tasks that eliminate idleness.

Specified by:

getLastUse in interface TimeoutCapable

setLastUse

public void setLastUse(long lastUse)

updateLastUse

public void updateLastUse()

getTimeoutManager

public TimeoutManager getTimeoutManager()

setTimeoutManager

public void setTimeoutManager(TimeoutManager timeoutManager)

getTimeoutTask

public Runnable getTimeoutTask()

setTimeoutTask

public void setTimeoutTask(Runnable timeoutTask)

getTimeoutFuture

public edu.emory.mathcs.backport.java.util.concurrent.Future getTimeoutFuture()

setTimeoutFuture

public void setTimeoutFuture(edu.emory.mathcs.backport.java.util.concurrent.Future timeoutFuture)

Description copied from interface: TimeoutCapable

Set the Future used to provide access to the Runnable task that invokes the timeout method. A Future is used instead of a Runnable so that it may be cancelled according to the Java concurrency standard.

Specified by:

setTimeoutFuture in interface TimeoutCapable

getTimeoutPeriod

public long getTimeoutPeriod()

Description copied from interface: TimeoutCapable

Determine the time, in milliseconds, that this object is allowed to idle before having its timeout method invoked.

Specified by:

getTimeoutPeriod in interface TimeoutCapable

setTimeoutPeriod

public void setTimeoutPeriod(long timeoutPeriod)