AbstractHandler (SNF4J 1.10.0 API)

java.lang.Object
- org.snf4j.core.handler.AbstractHandler

All Implemented Interfaces:

IHandler

Direct Known Subclasses:

AbstractDatagramHandler, AbstractSctpHandler, AbstractStreamHandler
```
public abstract class AbstractHandler
extends Object
implements IHandler
```
Base implementation of the IHandler interface.

Author:

SNF4J.ORG

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractHandler()` Default constructor creating an unnamed handler.
`protected`	`AbstractHandler(ISessionConfig config)` Default constructor creating an unnamed handler with given session configuration object.
`protected`	`AbstractHandler(String name)` Constructor creating a named handler.
`protected`	`AbstractHandler(String name, ISessionConfig config)` Constructor creating a named handler with given session configuration object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`event(DataEvent event, long length)` Called to notify about an I/O operation.
`void`	`event(SessionEvent event)` Called to notify about a change of the associated session state.
`void`	`exception(Throwable t)` Called to notify about an exception caught during processing of I/O or protocol related operations.
`ISessionConfig`	`getConfig()` Returns the configuration object that will be used to configure the behavior of the associated session.
`ISessionStructureFactory`	`getFactory()` Returns the factory object that will be used to configure the internal structure of the associated session.
`String`	`getName()` Returns the name of the handler.
`ISession`	`getSession()` Returns the session that is associated with this handler.
`boolean`	`incident(SessionIncident incident, Throwable t)` Called to notify about an incident that occurred during processing of I/O or protocol related operations.
`void`	`read(byte[] data)` Called when new bytes were read from the input buffer.
`void`	`read(ByteBuffer data)` Called when new bytes were read from the input buffer.
`void`	`setSession(ISession session)` Sets the session that will be associated with this handler.
`void`	`timer(Object event)` Called to notify about an expiration of the timer identified by the specified event object.
`void`	`timer(Runnable task)` Called to notify about an expiration of the timer associated with the specified task.

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
read

- Constructor Detail
  - AbstractHandler
```
protected AbstractHandler()
```
    Default constructor creating an unnamed handler.
  - AbstractHandler
```
protected AbstractHandler(ISessionConfig config)
```
    Default constructor creating an unnamed handler with given session configuration object.
    
    Parameters:
    
    config - the session configuration object, or null to use the default configuration
  - AbstractHandler
```
protected AbstractHandler(String name)
```
    Constructor creating a named handler.
    
    Parameters:
    
    name - the name for this handler
  - AbstractHandler
```
protected AbstractHandler(String name,
                          ISessionConfig config)
```
    Constructor creating a named 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)
```
    Description copied from interface: IHandler
    
    Sets the session that will be associated with this handler.
    
    Specified by:
    
    setSession in interface IHandler
    
    Parameters:
    
    session - the session
  - getSession
```
public ISession getSession()
```
    Description copied from interface: IHandler
    
    Returns the session that is associated with this handler.
    
    Specified by:
    
    getSession in interface IHandler
    
    Returns:
    
    the session
  - getName
```
public String getName()
```
    Description copied from interface: IHandler
    
    Returns the name of the handler. The name will be used to name the associated session created with the default constructor.
    
    Specified by:
    
    getName in interface IHandler
    
    Returns:
    
    the name or null if the name is not specified.
  - event
```
public void event(SessionEvent event)
```
    Description copied from interface: IHandler
    
    Called to notify about a change of the associated session state.
    
    Specified by:
    
    event in interface IHandler
    
    Parameters:
    
    event - an event related with the change of the session state
    
    See Also:
    
    SessionEvent
  - event
```
public void event(DataEvent event,
                  long length)
```
    Description copied from interface: IHandler
    
    Called to notify about an I/O operation.
    
    Specified by:
    
    event in interface IHandler
    
    Parameters:
    
    event - an event related with the type of I/O operation
    
    length - the number of bytes related with the I/O operation
    
    See Also:
    
    DataEvent
  - exception
```
public void exception(Throwable t)
```
    Description copied from interface: IHandler
    
    Called to notify about an exception caught during processing of I/O or protocol related operations. After returning form this method the associated session will be quickly closed.
    
    Specified by:
    
    exception in interface IHandler
    
    Parameters:
    
    t - the exception caught
  - incident
```
public boolean incident(SessionIncident incident,
                        Throwable t)
```
    Description copied from interface: IHandler
    
    Called to notify about an incident that occurred during processing of I/O or protocol related operations.
    
    Specified by:
    
    incident in interface IHandler
    
    Parameters:
    
    incident - an incident that occurred
    
    t - an exception that is related with the incident or null
    
    Returns:
    
    true to indicate that the incident was handled and the default action should not be executed by the SNF4J framework underneath.
  - timer
```
public void timer(Object event)
```
    Description copied from interface: IHandler
    
    Called to notify about an expiration of the timer identified by the specified event object.
    
    Specified by:
    
    timer in interface IHandler
    
    Parameters:
    
    event - the event object that identifies the timer
  - timer
```
public void timer(Runnable task)
```
    Description copied from interface: IHandler
    
    Called to notify about an expiration of the timer associated with the specified task. The passed task object has not been executed yet and it is up to the handler's implementation to execute it or not.
    
    Specified by:
    
    timer in interface IHandler
    
    Parameters:
    
    task - the task to execute
  - getFactory
```
public ISessionStructureFactory getFactory()
```
    Description copied from interface: IHandler
    
    Returns the factory object that will be used to configure the internal structure of the associated session.
    
    Specified by:
    
    getFactory in interface IHandler
    
    Returns:
    
    the factory object
    
    See Also:
    
    ISessionStructureFactory
  - getConfig
```
public ISessionConfig 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
    
    Returns:
    
    the configuration object
    
    See Also:
    
    ISessionConfig
  - read
```
public void read(byte[] data)
```
    Called when new bytes were read from the input buffer. This method is called when none of the conditions for calling other read methods are met.
    The passed array can be safely stored or modified by this method as it will not be used by the caller.
    By default it simply passes the data value to the IHandler.read(Object) method.
    
    Specified by:
    
    read in interface IHandler
    
    Parameters:
    
    data - bytes that was read from the input buffer.
  - read
```
public void read(ByteBuffer data)
```
    Called when new bytes were read from the input buffer. This method is called when the associated session is configured with a codec pipeline in which the last decoder produces ByteBuffer objects or when the associated session is configured to optimize data copying and uses an allocator supporting the releasing of no longer used buffers
    The passed byte buffer can be safely stored or modified by this method as it will not be used by the caller. However, if the associated session is configured to optimize data copying and uses an allocator supporting the releasing of no longer used buffers it may be required to release it in this method unless the original buffer has been already released by one of the associated decoders.
    By default it simply passes the data value to the IHandler.read(Object) method.
    
    Specified by:
    
    read in interface IHandler
    
    Parameters:
    
    data - bytes that was read from the input buffer.

Class AbstractHandler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractHandler

AbstractHandler

AbstractHandler

AbstractHandler

Method Detail

setSession

getSession

getName

event

event

exception

incident

timer

timer

getFactory

getConfig

read

read