Modifier and Type	Class and Description
public static class	Timeout.Task Task.

Modifier and Type	Field and Description
private long	_duration
private Timeout.Task	_head
private Object	_lock
private long	_now

Access	Constructor and Description
public	Timeout()
public	Timeout(Object lock)

Method Summary

Modifier and Type	Method and Description
public void	cancelAll()
public Timeout.Task	Returns: the next expired task or null. expired() Get an expired tasks.
public long	Returns: Returns the duration. getDuration()
public long	getNow()
public long	getTimeToNext()
public boolean	isEmpty()
public void	schedule(Timeout.Task task)
public void	schedule(Timeout.Task task, long A delay in addition to the default duration of the timeout delay)
public void	setDuration(long The duration to set. duration)
public long	setNow()
public void	setNow(long now)
public void	tick(long now)
public void	tick()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

_duration	back to summary
private long _duration

_head	back to summary
private Timeout.Task _head

_lock	back to summary
private Object _lock

_now	back to summary
private long _now

Constructor Detail

Timeout	back to summary
public Timeout()

Timeout	back to summary
public Timeout(Object lock)

Method Detail

cancelAll	back to summary
public void cancelAll()

expired back to summary

expired	back to summary
public Timeout.Task expired() Get an expired tasks. This is called instead of `tick()` to obtain the next expired Task, but without calling it's `Task#expire()` or `Task#expired()` methods. Returns:Timeout.Task the next expired task or null.

public Timeout.Task expired()

Get an expired tasks. This is called instead of tick() to obtain the next expired Task, but without calling it's Task#expire() or Task#expired() methods.

Returns:Timeout.Task: the next expired task or null.

getDuration	back to summary
public long getDuration() Returns:long Returns the duration.

getNow	back to summary
public long getNow()

getTimeToNext	back to summary
public long getTimeToNext()

isEmpty	back to summary
public boolean isEmpty()

schedule	back to summary
public void schedule(Timeout.Task task)

schedule	back to summary
public void schedule(Timeout.Task task, long delay) Parameters delay:long A delay in addition to the default duration of the timeout

setDuration	back to summary
public void setDuration(long duration) Parameters duration:long The duration to set.

setNow	back to summary
public long setNow()

setNow	back to summary
public void setNow(long now)

tick	back to summary
public void tick(long now)

tick	back to summary
public void tick()

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object.

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String: a string representation of the object.

org.mortbay.thread back to summary

public Class Timeout.Task

Class Inheritance

extends Object

java.lang.Object
org.mortbay.thread.Timeout.Task

Task. The base class for scheduled timeouts. This class should be extended to implement the expire() method, which is called if the timeout expires.

Author: gregw

Field Summary

Modifier and Type	Field and Description
pack-priv long	_delay
pack-priv boolean	_expired
pack-priv Timeout.Task	_next
pack-priv Timeout.Task	_prev
pack-priv Timeout	_timeout
pack-priv long	_timestamp

Constructor Summary

Access	Constructor and Description
public	Task()

Method Summary

Modifier and Type	Method and Description
public void	cancel() Cancel the task.
public void	expire() Expire task.
public void	expired() Expire task.
public long	getAge()
public long	getTimestamp()
public boolean	isExpired()
public boolean	isScheduled()
private void	link(Timeout.Task task)
public void	reschedule() Reschedule the task on the current timeout.
public void	schedule(Timeout timer) Schedule the task on the given timeout.
public void	schedule(Timeout timer, long delay) Schedule the task on the given timeout.
private void	unlink()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_delay	back to summary
pack-priv long _delay

_expired	back to summary
pack-priv boolean _expired

_next	back to summary
pack-priv Timeout.Task _next

_prev	back to summary
pack-priv Timeout.Task _prev

_timeout	back to summary
pack-priv Timeout _timeout

_timestamp	back to summary
pack-priv long _timestamp

Constructor Detail

Task	back to summary
public Task()

Method Detail

cancel	back to summary
public void cancel() Cancel the task. Remove the task from the timeout.

expire back to summary

expire	back to summary
public void expire() Expire task. This method is called when the timeout expires. It is called in the scope of the synchronize block (on this) that sets the `isExpired()` state to true. See Also `For an unsynchronized callback.`

public void expire()

Expire task. This method is called when the timeout expires. It is called in the scope of the synchronize block (on this) that sets the isExpired() state to true.

See Also: For an unsynchronized callback.

expired	back to summary
public void expired() Expire task. This method is called when the timeout expires. It is called outside of any synchronization scope and may be delayed.

getAge	back to summary
public long getAge()

getTimestamp	back to summary
public long getTimestamp()

isExpired	back to summary
public boolean isExpired()

isScheduled	back to summary
public boolean isScheduled()

link	back to summary
private void link(Timeout.Task task)

reschedule	back to summary
public void reschedule() Reschedule the task on the current timeout. The task timeout is rescheduled as if it had been cancelled and scheduled on the current timeout.

schedule	back to summary
public void schedule(Timeout timer) Schedule the task on the given timeout. The task exiry will be called after the timeout duration.

schedule	back to summary
public void schedule(Timeout timer, long delay) Schedule the task on the given timeout. The task exiry will be called after the timeout duration.

unlink	back to summary
private void unlink()

public Class Timeout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Timeout.Task

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail