org.apache.mina.core.session

Class ExpiringSessionRecycler

java.lang.Object

org.apache.mina.core.session.ExpiringSessionRecycler

All Implemented Interfaces:

IoSessionRecycler

public class ExpiringSessionRecycler
extends Object
implements IoSessionRecycler

An IoSessionRecycler with sessions that time out on inactivity.

Author:

Apache MINA Project

Field Summary

Fields inherited from interface org.apache.mina.core.session.IoSessionRecycler

NOOP

Constructor Summary

Constructors

Constructor and Description
ExpiringSessionRecycler() Create a new ExpiringSessionRecycler instance
ExpiringSessionRecycler(int timeToLive) Create a new ExpiringSessionRecycler instance
ExpiringSessionRecycler(int timeToLive, int expirationInterval) Create a new ExpiringSessionRecycler instance

Method Summary

Modifier and Type	Method and Description
int	getExpirationInterval()
int	getTimeToLive()
void	put(IoSession session) Called when the underlying transport creates or writes a new IoSession.
IoSession	recycle(SocketAddress remoteAddress, int port) Attempts to retrieve a recycled IoSession.
void	remove(IoSession session) Called when an IoSession is explicitly closed.
void	setExpirationInterval(int expirationInterval) Set the interval in which a session will live in the map before it is removed.
void	setTimeToLive(int timeToLive) Update the value for the time-to-live
void	stopExpiring() Stop the thread from monitoring the map

Methods inherited from class java.lang.Object

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

Constructor Detail

ExpiringSessionRecycler

public ExpiringSessionRecycler()

Create a new ExpiringSessionRecycler instance

ExpiringSessionRecycler

public ExpiringSessionRecycler(int timeToLive)

Create a new ExpiringSessionRecycler instance

Parameters:

timeToLive - The delay after which the session is going to be recycled

ExpiringSessionRecycler

public ExpiringSessionRecycler(int timeToLive,
                               int expirationInterval)

Create a new ExpiringSessionRecycler instance

Parameters:

timeToLive - The delay after which the session is going to be recycled

expirationInterval - The delay after which the expiration occurs

Method Detail

put

public void put(IoSession session)

Called when the underlying transport creates or writes a new IoSession.

Specified by:

put in interface IoSessionRecycler

Parameters:

session - the new IoSession.

recycle

public IoSession recycle(SocketAddress remoteAddress,
                         int port)

Attempts to retrieve a recycled IoSession.

Specified by:

recycle in interface IoSessionRecycler

Parameters:

remoteAddress - the remote socket address of the IoSession the transport wants to recycle.

port - The port the Accpetor is listening on

Returns:

a recycled IoSession, or null if one cannot be found.

remove

public void remove(IoSession session)

Called when an IoSession is explicitly closed.

Specified by:

remove in interface IoSessionRecycler

Parameters:

session - the new IoSession.

stopExpiring

public void stopExpiring()

Stop the thread from monitoring the map

getExpirationInterval

public int getExpirationInterval()

Returns:

The session expiration time in second

getTimeToLive

public int getTimeToLive()

Returns:

The session time-to-live in second

setExpirationInterval

public void setExpirationInterval(int expirationInterval)

Set the interval in which a session will live in the map before it is removed.

Parameters:

expirationInterval - The session expiration time in seconds

setTimeToLive

public void setTimeToLive(int timeToLive)

Update the value for the time-to-live

Parameters:

timeToLive - The time-to-live (seconds)