org.apache.mina.io
Class IoHandlerAdapter

java.lang.Object
  org.apache.mina.io.IoHandlerAdapter

All Implemented Interfaces:

IoHandler

Direct Known Subclasses:

StreamIoHandler

public class IoHandlerAdapter
extends java.lang.Object
implements IoHandler

An abstract adapter class for IoHandler. You can extend this class and selectively override required event handler methods only. All methods do nothing by default.

Please refer to NetCatProtocolHandler example.

Version:

$Rev: 326586 $, $Date: 2005-10-19 17:50:29 +0200 (Wed, 19 Oct 2005) $

Author:

The Apache Directory Project (dev@directory.apache.org)

Constructor Summary

IoHandlerAdapter()

Method Summary

void	dataRead(IoSession session, ByteBuffer buf) Invoked when data is read from the connection.
void	dataWritten(IoSession session, java.lang.Object marker) Invoked when MINA wrote IoSession.write(ByteBuffer, Object) request successfully.
void	exceptionCaught(IoSession session, java.lang.Throwable cause) Invoked when any exception is thrown by user IoHandler implementation or by MINA.
void	sessionClosed(IoSession session) Invoked when the connection is closed.
void	sessionCreated(IoSession session) Invoked when the session is created.
void	sessionIdle(IoSession session, IdleStatus status) Invoked when the connection is idle.
void	sessionOpened(IoSession session) Invoked when the connection is opened.

Methods inherited from class java.lang.Object

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

Constructor Detail

IoHandlerAdapter

public IoHandlerAdapter()

Method Detail

sessionCreated

public void sessionCreated(IoSession session)
                    throws java.lang.Exception

Description copied from interface: IoHandler

Invoked when the session is created. Initialize default socket parameters and user-defined attributes here.

Specified by:

sessionCreated in interface IoHandler

Throws:

java.lang.Exception

sessionOpened

public void sessionOpened(IoSession session)
                   throws java.lang.Exception

Description copied from interface: IoHandler

Invoked when the connection is opened. This method is not invoked if the transport type is UDP.

Specified by:

sessionOpened in interface IoHandler

Throws:

java.lang.Exception

sessionClosed

public void sessionClosed(IoSession session)
                   throws java.lang.Exception

Description copied from interface: IoHandler

Invoked when the connection is closed. This method is not invoked if the transport type is UDP.

Specified by:

sessionClosed in interface IoHandler

Throws:

java.lang.Exception

sessionIdle

public void sessionIdle(IoSession session,
                        IdleStatus status)
                 throws java.lang.Exception

Description copied from interface: IoHandler

Invoked when the connection is idle. Refer to IdleStatus. This method is not invoked if the transport type is UDP.

Specified by:

sessionIdle in interface IoHandler

Throws:

java.lang.Exception

exceptionCaught

public void exceptionCaught(IoSession session,
                            java.lang.Throwable cause)
                     throws java.lang.Exception

Description copied from interface: IoHandler

Invoked when any exception is thrown by user IoHandler implementation or by MINA. If cause is instanceof IOException, MINA will close the connection automatically.

Specified by:

exceptionCaught in interface IoHandler

Throws:

java.lang.Exception

dataRead

public void dataRead(IoSession session,
                     ByteBuffer buf)
              throws java.lang.Exception

Description copied from interface: IoHandler

Invoked when data is read from the connection. You can access buf to get read data. buf returns to the internal buffer pool of MINA after this method is invoked, so please don't try to reuse it.

Specified by:

dataRead in interface IoHandler

Throws:

java.lang.Exception

dataWritten

public void dataWritten(IoSession session,
                        java.lang.Object marker)
                 throws java.lang.Exception

Description copied from interface: IoHandler

Invoked when MINA wrote IoSession.write(ByteBuffer, Object) request successfully. marker is what you specified at the point of invocation of IoSession.write(ByteBuffer, Object).

Specified by:

dataWritten in interface IoHandler

Throws:

java.lang.Exception