org.apache.mina.common
Class IoHandlerAdapter

java.lang.Object
  extended by org.apache.mina.common.IoHandlerAdapter
All Implemented Interfaces:
IoHandler
Direct Known Subclasses:
ChainedIoHandler, DemuxingIoHandler, StreamIoHandler

public class IoHandlerAdapter
extends 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.

Version:
$Rev: 436993 $, $Date: 2006-08-26 00:36:56 +0200 (Sat, 26 Aug 2006) $
Author:
The Apache Directory Project (mina-dev@directory.apache.org)

Constructor Summary
IoHandlerAdapter()
           
 
Method Summary
 void exceptionCaught(IoSession session, Throwable cause)
          Invoked when any exception is thrown by user IoHandler implementation or by MINA.
 void messageReceived(IoSession session, Object message)
          Invoked when protocol message is received.
 void messageSent(IoSession session, Object message)
          Invoked when protocol message that user requested by IoSession.write(Object) is sent out actually.
 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 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:
Exception

sessionOpened

public void sessionOpened(IoSession session)
                   throws 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:
Exception

sessionClosed

public void sessionClosed(IoSession session)
                   throws 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:
Exception

sessionIdle

public void sessionIdle(IoSession session,
                        IdleStatus status)
                 throws 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:
Exception

exceptionCaught

public void exceptionCaught(IoSession session,
                            Throwable cause)
                     throws 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:
Exception

messageReceived

public void messageReceived(IoSession session,
                            Object message)
                     throws Exception
Description copied from interface: IoHandler
Invoked when protocol message is received. Implement your protocol flow here.

Specified by:
messageReceived in interface IoHandler
Throws:
Exception

messageSent

public void messageSent(IoSession session,
                        Object message)
                 throws Exception
Description copied from interface: IoHandler
Invoked when protocol message that user requested by IoSession.write(Object) is sent out actually.

Specified by:
messageSent in interface IoHandler
Throws:
Exception


Copyright © 2004-2009 Apache MINA Project. All Rights Reserved.