org.snf4j.core.handler

Class AbstractSctpHandler

java.lang.Object

org.snf4j.core.handler.AbstractHandler

org.snf4j.core.handler.AbstractSctpHandler

All Implemented Interfaces:

IHandler, ISctpHandler, ISctpReader

Direct Known Subclasses:

SctpServerHandler

public abstract class AbstractSctpHandler
extends AbstractHandler
implements ISctpHandler

Base implementation of the ISctpHandler interface.

Author:

SNF4J.ORG

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSctpHandler() Default constructor creating an unnamed SCTP handler.
protected	AbstractSctpHandler(String name) Constructor creating a named SCTP handler.

Method Summary

Modifier and Type	Method and Description
ISctpSessionConfig	getConfig() Returns the configuration object that will be used to configure the behavior of the associated session.
ISctpSession	getSession() Returns the session that is associated with this handler.
com.sun.nio.sctp.HandlerResult	notification(com.sun.nio.sctp.Notification notification, SctpNotificationType type) Handles notifications from the SCTP stack.
void	read(byte[] msg, com.sun.nio.sctp.MessageInfo msgInfo) Called when a new message was received from the remote end.
void	read(ByteBuffer msg, com.sun.nio.sctp.MessageInfo msgInfo) Called when a new message was received from the remote end.
void	read(Object msg) Not used.
void	setSession(ISession session) Sets the session that will be associated with this handler.

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

event, event, exception, 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.ISctpHandler

read, read, read

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

event, event, exception, getFactory, getName, incident, timer, timer

Constructor Detail

AbstractSctpHandler

protected AbstractSctpHandler()

Default constructor creating an unnamed SCTP handler.

AbstractSctpHandler

protected AbstractSctpHandler(String name)

Constructor creating a named SCTP handler.

Parameters:

name - the name for this handler

Method Detail

setSession

public void setSession(ISession session)

Description copied from interface: IHandler

Sets the session that will be associated with this handler.

Specified by:

setSession in interface IHandler

Specified by:

setSession in interface ISctpHandler

Overrides:

setSession in class AbstractHandler

Parameters:

session - the session

getSession

public ISctpSession 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 ISctpHandler

Overrides:

getSession in class AbstractHandler

Returns:

the session

getConfig

public ISctpSessionConfig getConfig()

Description copied from interface: IHandler

Returns the configuration object that will be used to configure the behavior of the associated session.

Specified by:

getConfig in interface IHandler

Specified by:

getConfig in interface ISctpHandler

Overrides:

getConfig in class AbstractHandler

Returns:

the configuration object

See Also:

ISessionConfig

read

public void read(byte[] msg,
                 com.sun.nio.sctp.MessageInfo msgInfo)

Description copied from interface: ISctpHandler

Called when a new message was received from the remote end.

The passed array can be safely stored or modified by this method as it will not be used by the caller.

This method is also called when the associated session is configured with a codec pipeline in which the last decoder produces outbound object(s) of the byte[] type.

Specified by:

read in interface ISctpHandler

Specified by:

read in interface ISctpReader

Parameters:

msg - the message received from the remote end.

msgInfo - additional ancillary information about the received message.

read

public void read(ByteBuffer msg,
                 com.sun.nio.sctp.MessageInfo msgInfo)

Description copied from interface: ISctpHandler

Called when a new message was received from the remote end. This method is only called when the associated session is configured to optimize data copying and uses an allocator supporting the releasing of no longer used buffers.

The passed buffer can be safely stored or modified by this method as it will not be used by the caller.

This method is also called when the associated session is configured with a codec pipeline in which the last decoder produces outbound object(s) of the ByteBuffer type.

Specified by:

read in interface ISctpHandler

Specified by:

read in interface ISctpReader

Parameters:

msg - the message received from the remote end.

msgInfo - additional ancillary information about the received message.

read

public void read(Object msg)

Not used.

It does nothing by default.

Specified by:

read in interface IHandler

Specified by:

read in interface ISctpHandler

Parameters:

msg - the message that was read and decoded from the input buffer.

notification

public com.sun.nio.sctp.HandlerResult notification(com.sun.nio.sctp.Notification notification,
                                                   SctpNotificationType type)

Handles notifications from the SCTP stack.

It returns HandlerResult.CONTINUE by default.

Specified by:

notification in interface ISctpHandler

Parameters:

notification - a notification from the SCTP stack

type - the type of received notification

Returns:

the handler result