org.apache.mina.common
Interface IoHandler

All Known Implementing Classes:

ChainedIoHandler, DemuxingIoHandler, IoHandlerAdapter, SingleSessionIoHandlerDelegate, StreamIoHandler

public interface IoHandler

Handles all protocol events fired by MINA. There are 6 event handler methods, and they are all invoked by MINA automatically.

Please refer to ReverseIoHandler example.

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)

See Also:

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.

Method Detail

sessionCreated

void sessionCreated(IoSession session)
                    throws Exception

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

Throws:

Exception

sessionOpened

void sessionOpened(IoSession session)
                   throws Exception

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

Throws:

Exception

sessionClosed

void sessionClosed(IoSession session)
                   throws Exception

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

Throws:

Exception

sessionIdle

void sessionIdle(IoSession session,
                 IdleStatus status)
                 throws Exception

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

Throws:

Exception

exceptionCaught

void exceptionCaught(IoSession session,
                     Throwable cause)
                     throws Exception

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

Throws:

Exception

messageReceived

void messageReceived(IoSession session,
                     Object message)
                     throws Exception

Invoked when protocol message is received. Implement your protocol flow here.

Throws:

Exception

messageSent

void messageSent(IoSession session,
                 Object message)
                 throws Exception

Invoked when protocol message that user requested by IoSession.write(Object) is sent out actually.

Throws:

Exception