Package org.glassfish.grizzly.portunif

Class BackChannelFilter

java.lang.Object

org.glassfish.grizzly.filterchain.BaseFilter

org.glassfish.grizzly.portunif.BackChannelFilter

All Implemented Interfaces:

Filter

public class BackChannelFilter
extends BaseFilter

The Filter, which is responsible to connect custom protocol FilterChain with main FilterChain. Usually this Filter is getting added to the custom protocol FilterChain as first Filter.

Author:

Alexey Stashok

Method Summary

Modifier and Type	Method	Description
void	exceptionOccurred(FilterChainContext ctx, Throwable error)	Notification about exception, occurred on the FilterChain
NextAction	handleEvent(FilterChainContext ctx, FilterChainEvent event)	Handle custom event associated with the Connection.
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.

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

createContext, handleAccept, handleClose, handleConnect, onAdded, onFilterChainChanged, onRemoved, toString

Methods inherited from class java.lang.Object

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

Method Details

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

handleEvent

public NextAction handleEvent(FilterChainContext ctx,
 FilterChainEvent event)
                       throws IOException

Description copied from class: BaseFilter

Handle custom event associated with the Connection. This Filter may either complete the required processing and return StopAction, or delegate remaining processing to the next Filter in a FilterChain containing this Filter by returning InvokeAction.

Specified by:

handleEvent in interface Filter

Overrides:

handleEvent in class BaseFilter

Parameters:

ctx - FilterChainContext

Returns:

NextAction instruction for FilterChain, how it should continue the execution

Throws:

IOException

exceptionOccurred

public void exceptionOccurred(FilterChainContext ctx,
 Throwable error)

Description copied from class: BaseFilter

Notification about exception, occurred on the FilterChain

Specified by:

exceptionOccurred in interface Filter

Overrides:

exceptionOccurred in class BaseFilter

Parameters:

ctx - event processing FilterChainContext

error - error, which occurred during FilterChain execution