org.snf4j.core.handler

Class AbstractStreamHandler

java.lang.Object

org.snf4j.core.handler.AbstractHandler

org.snf4j.core.handler.AbstractStreamHandler

All Implemented Interfaces:

IHandler, IStreamHandler, IStreamReader

Direct Known Subclasses:

AbstractFileHandler, AbstractProxyHandler, AbstractWebSocketHandler, ChatClientHandler, ChatServerHandler, DiscardingClientHandler, DiscardingServerHandler, EchoClientHandler, EchoServerHandler, EngineClientHandler, EngineServerHandler

public abstract class AbstractStreamHandler
extends AbstractHandler
implements IStreamHandler

Base implementation of the IStreamHandler interface.

Author:

SNF4J.ORG

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractStreamHandler() Default constructor creating an unnamed stream-oriented handler.
protected	AbstractStreamHandler(ISessionConfig config) Constructor creating an unnamed stream-oriented handler with given session configuration object.
protected	AbstractStreamHandler(String name) Constructor creating a named stream-oriented handler.
protected	AbstractStreamHandler(String name, ISessionConfig config) Constructor creating a named stream-oriented handler with given session configuration object.

Method Summary

Modifier and Type	Method and Description
int	available(byte[] buffer, int off, int len) Determines how many bytes can be read from the input buffer after receiving new data from the remote end.
int	available(ByteBuffer buffer, boolean flipped) Determines how many bytes can be read from the input buffer after receiving new data from the remote end.
IStreamSession	getSession() Returns the session that is associated with this handler.
void	setSession(ISession session) Sets the stream-oriented session that will be associated with this handler.

Methods inherited from class org.snf4j.core.handler.AbstractHandler

event, event, exception, getConfig, getFactory, getName, incident, read, read, timer, timer

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.snf4j.core.handler.IHandler

event, event, exception, getConfig, getFactory, getName, incident, read, read, read, timer, timer

Methods inherited from interface org.snf4j.core.IStreamReader

read, read

Constructor Detail

AbstractStreamHandler

protected AbstractStreamHandler()

Default constructor creating an unnamed stream-oriented handler.

AbstractStreamHandler

protected AbstractStreamHandler(ISessionConfig config)

Constructor creating an unnamed stream-oriented handler with given session configuration object.

Parameters:

config - the session configuration object, or null to use the default configuration

AbstractStreamHandler

protected AbstractStreamHandler(String name)

Constructor creating a named stream-oriented handler.

Parameters:

name - the name for this handler

AbstractStreamHandler

protected AbstractStreamHandler(String name,
                                ISessionConfig config)

Constructor creating a named stream-oriented handler with given session configuration object.

Parameters:

name - the name for this handler

config - the session configuration object, or null to use the default configuration

Method Detail

setSession

public void setSession(ISession session)

Sets the stream-oriented session that will be associated with this handler.

Specified by:

setSession in interface IHandler

Specified by:

setSession in interface IStreamHandler

Overrides:

setSession in class AbstractHandler

Parameters:

session - the session

Throws:

IllegalArgumentException - if the session argument is not an instance of the IStreamSession interface.

getSession

public IStreamSession getSession()

Description copied from interface: IHandler

Returns the session that is associated with this handler.

Specified by:

getSession in interface IHandler

Specified by:

getSession in interface IStreamHandler

Overrides:

getSession in class AbstractHandler

Returns:

the session

available

public int available(ByteBuffer buffer,
                     boolean flipped)

Determines how many bytes can be read from the input buffer after receiving new data from the remote end. The specified number of bytes will be then passed as a byte array to the read method.

This method is called only if the input buffer is not backed by an array. The type of the input buffer is specified by the implementation of the ISessionStructureFactory returned by the getFactory method.

The inner state of the passed buffer cannot be changed by this method.

This implementation always returns total number of bytes in the buffer.

Specified by:

available in interface IStreamReader

Parameters:

buffer - the input buffer.

flipped - specifies the current mode of the buffer

Returns:

the number of bytes to read or 0 if the buffer has not enough data yet and the reading should skipped now.

available

public int available(byte[] buffer,
                     int off,
                     int len)

Determines how many bytes can be read from the input buffer after receiving new data from the remote end. The specified number of bytes will be then passed as a byte array to the read method.

This method is called only if the input buffer is backed by an array. The type of the input buffer is specified by the implementation of the ISessionStructureFactory returned by the getFactory method.

The content of the passed buffer cannot be changed by this method.

This implementation always returns total number of bytes in the array (i.e. the len value).

Specified by:

available in interface IStreamReader

Parameters:

buffer - the array that backs the input buffer.

off - the offset of the array

len - the number of the bytes in the array

Returns:

number of bytes to read or 0 if the buffer has not enough data yet and the reading should skipped now.