ch.dermitza.securenio.socket.timeout.worker

Class Timeout

java.lang.Object

ch.dermitza.securenio.socket.timeout.worker.Timeout

All Implemented Interfaces:

java.lang.Comparable<Timeout>

public class Timeout
extends java.lang.Object
implements java.lang.Comparable<Timeout>

A timeout implementation to be used with a TimeoutWorker. Timeouts are associated with a SocketIF and a TimeoutListener. When a timeout is expired, it notifies the listener of the expiration, at which time the listener should act on the timeout (e.g. closing the socket, performing an SSL/TLS re-handshake and so on).

Since:

0.18

See Also:

TimeoutWorker, TimeoutWorker

Field Summary

Fields

Modifier and Type	Field and Description
static int	GENERIC_TIMEOUT Unused TODO
static int	SSL_TIMEOUT Unused TODO

Constructor Summary

Constructors

Constructor and Description
Timeout(SocketIF socket, TimeoutListener listener, long timeout) Create a new timeout for the SocketIF given.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Timeout t) Overrides the Comparable interface to allow timeouts to be compared.
void	expired() Sets this timeout to expired state, firing any attached listeners in the process.
long	getCreated() Get the time this timeout was created
long	getDelta() Get the absolute expiration time of this timeout
SocketIF	getSocket() Get the SocketIF this timeout is associated with
long	getTimeout() Get the timeout period
boolean	hasExpired() Whether or not this timeout already had its associated expired() method called and had its TimeoutListener fired.
boolean	isExpired() Check whether or not this timeout is expired right now.

Methods inherited from class java.lang.Object

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

Field Detail

SSL_TIMEOUT

public static final int SSL_TIMEOUT

Unused TODO

See Also:

Constant Field Values

GENERIC_TIMEOUT

public static final int GENERIC_TIMEOUT

Unused TODO

See Also:

Constant Field Values

Constructor Detail

Timeout

public Timeout(SocketIF socket,
       TimeoutListener listener,
       long timeout)

Create a new timeout for the SocketIF given. If the timeout expires, it will fire TimeoutListener.timeoutExpired(SocketIF) on the associated listener.

Parameters:

socket - The socket the timeout is to be associated with

listener - The listener listening for timeout expiration on this socket

timeout - The timeout period

Method Detail

getSocket

public SocketIF getSocket()

Get the SocketIF this timeout is associated with

Returns:

the SocketIF this timeout is associated with

getTimeout

public long getTimeout()

Get the timeout period

Returns:

the timeout period

getCreated

public long getCreated()

Get the time this timeout was created

Returns:

the time this timeout was created

getDelta

public long getDelta()

Get the absolute expiration time of this timeout

Returns:

the absolute expiration time of this timeout

expired

public void expired()

Sets this timeout to expired state, firing any attached listeners in the process.

isExpired

public boolean isExpired()

Check whether or not this timeout is expired right now. If the timeout was set to its expired state via expired(), time checking is not performed, returning true directly.

Returns:

whether or not this timeout is expired right now

hasExpired

public boolean hasExpired()

Whether or not this timeout already had its associated expired() method called and had its TimeoutListener fired.

Returns:

Whether or not this timeout already had its associated expired() method called and had its TimeoutListener fired.

compareTo

public int compareTo(Timeout t)

Overrides the Comparable interface to allow timeouts to be compared. Timeouts are compared based on their absolute expiration times.

Specified by:

compareTo in interface java.lang.Comparable<Timeout>

Parameters:

t - The timeout to compare to

Returns:

A negative value if the current timeout's expiration time is earlier than the one of the given timeout, a positive value if it is later, or 0 if both timeouts expire at the same time