org.glassfish.grizzly.utils

Class IdleTimeoutFilter

java.lang.Object

org.glassfish.grizzly.filterchain.BaseFilter

org.glassfish.grizzly.utils.IdleTimeoutFilter

All Implemented Interfaces:

Filter

public class IdleTimeoutFilter
extends BaseFilter

The Filter is responsible for tracking Connection activity and closing Connection once it becomes idle for certain amount of time. Unlike ActivityCheckFilter, this Filter assumes Connection is idle, when no event is being executed on it. But if some event processing was suspended - this Filter still assumes Connection is active.

Author:

Alexey Stashok

See Also:

ActivityCheckFilter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IdleTimeoutFilter.TimeoutHandler
static interface	IdleTimeoutFilter.TimeoutResolver

Field Summary

Fields

Modifier and Type	Field and Description
static Long	FOREVER
static Long	FOREVER_SPECIAL
static String	IDLE_ATTRIBUTE_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IdleTimeoutFilter(DelayedExecutor executor, DelayedExecutor.Worker<Connection> worker, IdleTimeoutFilter.TimeoutResolver timeoutResolver)
	IdleTimeoutFilter(DelayedExecutor executor, IdleTimeoutFilter.TimeoutResolver timeoutResolver)
	IdleTimeoutFilter(DelayedExecutor executor, IdleTimeoutFilter.TimeoutResolver timeoutResolver, IdleTimeoutFilter.TimeoutHandler handler)
	IdleTimeoutFilter(DelayedExecutor executor, long timeout, TimeUnit timeoutUnit)
	IdleTimeoutFilter(DelayedExecutor executor, long timeout, TimeUnit timeUnit, IdleTimeoutFilter.TimeoutHandler handler)

Method Summary

Modifier and Type	Method and Description
static DelayedExecutor	createDefaultIdleDelayedExecutor()
static DelayedExecutor	createDefaultIdleDelayedExecutor(long checkInterval, TimeUnit checkIntervalUnit)
DelayedExecutor.Resolver<Connection>	getResolver()
NextAction	handleAccept(FilterChainContext ctx) Execute a unit of processing work to be performed, when server channel has accepted the client connection.
NextAction	handleClose(FilterChainContext ctx) Execute a unit of processing work to be performed, when connection has been closed.
NextAction	handleConnect(FilterChainContext ctx) Execute a unit of processing work to be performed, when channel gets connected.
NextAction	handleRead(FilterChainContext ctx) Execute a unit of processing work to be performed, when channel will become available for reading.
NextAction	handleWrite(FilterChainContext ctx) Execute a unit of processing work to be performed, when some data should be written on channel.
protected void	queueAction(FilterChainContext ctx)
static void	setCustomTimeout(Connection connection, long timeout, TimeUnit timeunit) Provides an override mechanism for the default timeout.

Methods inherited from class org.glassfish.grizzly.filterchain.BaseFilter

createContext, exceptionOccurred, handleEvent, onAdded, onFilterChainChanged, onRemoved, toString

Methods inherited from class java.lang.Object

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

Field Detail

FOREVER

public static final Long FOREVER

FOREVER_SPECIAL

public static final Long FOREVER_SPECIAL

IDLE_ATTRIBUTE_NAME

public static final String IDLE_ATTRIBUTE_NAME

See Also:

Constant Field Values

Constructor Detail

IdleTimeoutFilter

public IdleTimeoutFilter(DelayedExecutor executor,
                         long timeout,
                         TimeUnit timeoutUnit)

IdleTimeoutFilter

public IdleTimeoutFilter(DelayedExecutor executor,
                         IdleTimeoutFilter.TimeoutResolver timeoutResolver)

IdleTimeoutFilter

public IdleTimeoutFilter(DelayedExecutor executor,
                         long timeout,
                         TimeUnit timeUnit,
                         IdleTimeoutFilter.TimeoutHandler handler)

IdleTimeoutFilter

public IdleTimeoutFilter(DelayedExecutor executor,
                         IdleTimeoutFilter.TimeoutResolver timeoutResolver,
                         IdleTimeoutFilter.TimeoutHandler handler)

IdleTimeoutFilter

protected IdleTimeoutFilter(DelayedExecutor executor,
                            DelayedExecutor.Worker<Connection> worker,
                            IdleTimeoutFilter.TimeoutResolver timeoutResolver)

Method Detail

handleAccept

public NextAction handleAccept(FilterChainContext ctx)
                        throws IOException

Description copied from class: BaseFilter

Execute a unit of processing work to be performed, when server channel has accepted the client connection. This Filter may either complete the required processing and return false, or delegate remaining processing to the next Filter in a FilterChain containing this Filter by returning true.

Specified by:

handleAccept in interface Filter

Overrides:

handleAccept in class BaseFilter

Parameters:

ctx - FilterChainContext

Returns:

NextAction instruction for FilterChain, how it should continue the execution

Throws:

IOException

handleConnect

public NextAction handleConnect(FilterChainContext ctx)
                         throws IOException

Description copied from class: BaseFilter

Execute a unit of processing work to be performed, when channel gets connected. This Filter may either complete the required processing and return false, or delegate remaining processing to the next Filter in a FilterChain containing this Filter by returning true.

Specified by:

handleConnect in interface Filter

Overrides:

handleConnect in class BaseFilter

Parameters:

ctx - FilterChainContext

Returns:

NextAction instruction for FilterChain, how it should continue the execution

Throws:

IOException

handleRead

public NextAction handleRead(FilterChainContext ctx)
                      throws IOException

Description copied from class: BaseFilter

Execute a unit of processing work to be performed, when channel will become available for reading. This Filter may either complete the required processing and return false, or delegate remaining processing to the next Filter in a FilterChain containing this Filter by returning true.

Specified by:

handleRead in interface Filter

Overrides:

handleRead in class BaseFilter

Parameters:

ctx - FilterChainContext

Returns:

NextAction instruction for FilterChain, how it should continue the execution

Throws:

IOException

handleWrite

public NextAction handleWrite(FilterChainContext ctx)
                       throws IOException

Description copied from class: BaseFilter

Execute a unit of processing work to be performed, when some data should be written on channel. This Filter may either complete the required processing and return false, or delegate remaining processing to the next Filter in a FilterChain containing this Filter by returning true.

Specified by:

handleWrite in interface Filter

Overrides:

handleWrite in class BaseFilter

Parameters:

ctx - FilterChainContext

Returns:

NextAction instruction for FilterChain, how it should continue the execution

Throws:

IOException

handleClose

public NextAction handleClose(FilterChainContext ctx)
                       throws IOException

Description copied from class: BaseFilter

Execute a unit of processing work to be performed, when connection has been closed. This Filter may either complete the required processing and return false, or delegate remaining processing to the next Filter in a FilterChain containing this Filter by returning true.

Specified by:

handleClose in interface Filter

Overrides:

handleClose in class BaseFilter

Parameters:

ctx - FilterChainContext

Returns:

NextAction instruction for FilterChain, how it should continue the execution

Throws:

IOException

getResolver

public DelayedExecutor.Resolver<Connection> getResolver()

createDefaultIdleDelayedExecutor

public static DelayedExecutor createDefaultIdleDelayedExecutor()

createDefaultIdleDelayedExecutor

public static DelayedExecutor createDefaultIdleDelayedExecutor(long checkInterval,
                                                               TimeUnit checkIntervalUnit)

setCustomTimeout

public static void setCustomTimeout(Connection connection,
                                    long timeout,
                                    TimeUnit timeunit)

Provides an override mechanism for the default timeout.

Parameters:

connection - The Connection which is having the idle detection adjusted.

timeout - the new idle timeout.

timeunit - TimeUnit.

queueAction

protected void queueAction(FilterChainContext ctx)