org.apache.mina.handler.demux

类 DemuxingIoHandler

java.lang.Object

org.apache.mina.core.service.IoHandlerAdapter

org.apache.mina.handler.demux.DemuxingIoHandler

所有已实现的接口:

IoHandler

public class DemuxingIoHandler
extends IoHandlerAdapter

A IoHandler that demuxes messageReceived events to the appropriate MessageHandler.

You can freely register and deregister MessageHandlers using addReceivedMessageHandler(Class, MessageHandler) and removeReceivedMessageHandler(Class).

When message is received through a call to messageReceived(IoSession, Object) the class of the message object will be used to find a MessageHandler for that particular message type. If no MessageHandler instance can be found for the immediate class (i.e. message.getClass()) the interfaces implemented by the immediate class will be searched in depth-first order. If no match can be found for any of the interfaces the search will be repeated recursively for the superclass of the immediate class (i.e. message.getClass().getSuperclass()).

Consider the following type hierarchy (Cx are classes while Ix are interfaces):

     C3 - I7 - I9
      |    |   /\
      |   I8  I3 I4
      |
     C2 - I5 - I6
      |
     C1 - I1 - I2 - I4
      |         |
      |        I3
    Object
 

When message is of type C3 this hierarchy will be searched in the following order: C3, I7, I8, I9, I3, I4, C2, I5, I6, C1, I1, I2, I3, I4, Object.

For efficiency searches will be cached. Calls to addReceivedMessageHandler(Class, MessageHandler) and removeReceivedMessageHandler(Class) clear this cache.

作者:

Apache MINA Project

构造器概要

构造器

构造器和说明
DemuxingIoHandler() Creates a new instance with no registered MessageHandlers.

方法概要

方法

限定符和类型	方法和说明
<E extends java.lang.Throwable> ExceptionHandler<? super E>	addExceptionHandler(java.lang.Class<E> type, ExceptionHandler<? super E> handler) Registers a MessageHandler that receives the messages of the specified type.
<E> MessageHandler<? super E>	addReceivedMessageHandler(java.lang.Class<E> type, MessageHandler<? super E> handler) Registers a MessageHandler that handles the received messages of the specified type.
<E> MessageHandler<? super E>	addSentMessageHandler(java.lang.Class<E> type, MessageHandler<? super E> handler) Registers a MessageHandler that handles the sent messages of the specified type.
void	exceptionCaught(IoSession session, java.lang.Throwable cause) Invoked when any exception is thrown by user IoHandler implementation or by MINA.
protected ExceptionHandler<java.lang.Throwable>	findExceptionHandler(java.lang.Class<? extends java.lang.Throwable> type)
protected MessageHandler<java.lang.Object>	findReceivedMessageHandler(java.lang.Class<?> type)
protected MessageHandler<java.lang.Object>	findSentMessageHandler(java.lang.Class<?> type)
java.util.Map<java.lang.Class<?>,ExceptionHandler<?>>	getExceptionHandlerMap()
<E> MessageHandler<? super E>	getMessageHandler(java.lang.Class<E> type)
java.util.Map<java.lang.Class<?>,MessageHandler<?>>	getReceivedMessageHandlerMap()
java.util.Map<java.lang.Class<?>,MessageHandler<?>>	getSentMessageHandlerMap()
void	messageReceived(IoSession session, java.lang.Object message) Forwards the received events into the appropriate MessageHandler which is registered by addReceivedMessageHandler(Class, MessageHandler).
void	messageSent(IoSession session, java.lang.Object message) Invoked when a message written by IoSession.write(Object) is sent out.
<E extends java.lang.Throwable> ExceptionHandler<? super E>	removeExceptionHandler(java.lang.Class<E> type) Deregisters a MessageHandler that receives the messages of the specified type.
<E> MessageHandler<? super E>	removeReceivedMessageHandler(java.lang.Class<E> type) Deregisters a MessageHandler that handles the received messages of the specified type.
<E> MessageHandler<? super E>	removeSentMessageHandler(java.lang.Class<E> type) Deregisters a MessageHandler that handles the sent messages of the specified type.

从类继承的方法 org.apache.mina.core.service.IoHandlerAdapter

inputClosed, sessionClosed, sessionCreated, sessionIdle, sessionOpened

从类继承的方法 java.lang.Object

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

构造器详细资料

DemuxingIoHandler

public DemuxingIoHandler()

Creates a new instance with no registered MessageHandlers.

方法详细资料

addReceivedMessageHandler

public <E> MessageHandler<? super E> addReceivedMessageHandler(java.lang.Class<E> type,
                                                      MessageHandler<? super E> handler)

Registers a MessageHandler that handles the received messages of the specified type.

类型参数:

E - The message handler's type

参数:

type - The message's type

handler - The message handler

返回:

the old handler if there is already a registered handler for the specified type. null otherwise.

removeReceivedMessageHandler

public <E> MessageHandler<? super E> removeReceivedMessageHandler(java.lang.Class<E> type)

Deregisters a MessageHandler that handles the received messages of the specified type.

类型参数:

E - The message handler's type

参数:

type - The message's type

返回:

the removed handler if successfully removed. null otherwise.

addSentMessageHandler

public <E> MessageHandler<? super E> addSentMessageHandler(java.lang.Class<E> type,
                                                  MessageHandler<? super E> handler)

Registers a MessageHandler that handles the sent messages of the specified type.

类型参数:

E - The message handler's type

参数:

type - The message's type

handler - The message handler

返回:

the old handler if there is already a registered handler for the specified type. null otherwise.

removeSentMessageHandler

public <E> MessageHandler<? super E> removeSentMessageHandler(java.lang.Class<E> type)

Deregisters a MessageHandler that handles the sent messages of the specified type.

类型参数:

E - The message handler's type

参数:

type - The message's type

返回:

the removed handler if successfully removed. null otherwise.

addExceptionHandler

public <E extends java.lang.Throwable> ExceptionHandler<? super E> addExceptionHandler(java.lang.Class<E> type,
                                                                              ExceptionHandler<? super E> handler)

Registers a MessageHandler that receives the messages of the specified type.

类型参数:

E - The message handler's type

参数:

type - The message's type

handler - The Exception handler

返回:

the old handler if there is already a registered handler for the specified type. null otherwise.

removeExceptionHandler

public <E extends java.lang.Throwable> ExceptionHandler<? super E> removeExceptionHandler(java.lang.Class<E> type)

Deregisters a MessageHandler that receives the messages of the specified type.

类型参数:

E - The Exception Handler's type

参数:

type - The message's type

返回:

the removed handler if successfully removed. null otherwise.

getMessageHandler

public <E> MessageHandler<? super E> getMessageHandler(java.lang.Class<E> type)

类型参数:

E - The message handler's type

参数:

type - The message's type

返回:

the MessageHandler which is registered to process the specified type.

getReceivedMessageHandlerMap

public java.util.Map<java.lang.Class<?>,MessageHandler<?>> getReceivedMessageHandlerMap()

返回:

the Map which contains all messageType-MessageHandler pairs registered to this handler for received messages.

getSentMessageHandlerMap

public java.util.Map<java.lang.Class<?>,MessageHandler<?>> getSentMessageHandlerMap()

返回:

the Map which contains all messageType-MessageHandler pairs registered to this handler for sent messages.

getExceptionHandlerMap

public java.util.Map<java.lang.Class<?>,ExceptionHandler<?>> getExceptionHandlerMap()

返回:

the Map which contains all messageType-MessageHandler pairs registered to this handler.

messageReceived

public void messageReceived(IoSession session,
                   java.lang.Object message)
                     throws java.lang.Exception

Forwards the received events into the appropriate MessageHandler which is registered by addReceivedMessageHandler(Class, MessageHandler). Warning ! If you are to overload this method, be aware that you _must_ call the messageHandler in your own method, otherwise it won't be called. Invoked when a message is received.

指定者:

messageReceived 在接口中 IoHandler

覆盖:

messageReceived 在类中 IoHandlerAdapter

参数:

session - The session that is receiving a message

message - The received message

抛出:

java.lang.Exception - If we get an exception while processing the received message

messageSent

public void messageSent(IoSession session,
               java.lang.Object message)
                 throws java.lang.Exception

Invoked when a message written by IoSession.write(Object) is sent out. Warning ! If you are to overload this method, be aware that you _must_ call the messageHandler in your own method, otherwise it won't be called. Invoked when a message written by IoSession.write(Object) is sent out.

指定者:

messageSent 在接口中 IoHandler

覆盖:

messageSent 在类中 IoHandlerAdapter

参数:

session - The session that has sent a full message

message - The sent message

抛出:

java.lang.Exception - If we get an exception while processing the sent message

exceptionCaught

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

Invoked when any exception is thrown by user IoHandler implementation or by MINA. If cause is an instance of IOException, MINA will close the connection automatically. Warning ! If you are to overload this method, be aware that you _must_ call the messageHandler in your own method, otherwise it won't be called. Invoked when any exception is thrown by user IoHandler implementation or by MINA. If cause is an instance of IOException, MINA will close the connection automatically.

指定者:

exceptionCaught 在接口中 IoHandler

覆盖:

exceptionCaught 在类中 IoHandlerAdapter

参数:

session - The session for which we have got an exception

cause - The exception that has been caught

抛出:

java.lang.Exception - If we get an exception while processing the caught exception

findReceivedMessageHandler

protected MessageHandler<java.lang.Object> findReceivedMessageHandler(java.lang.Class<?> type)

findSentMessageHandler

protected MessageHandler<java.lang.Object> findSentMessageHandler(java.lang.Class<?> type)

findExceptionHandler

protected ExceptionHandler<java.lang.Throwable> findExceptionHandler(java.lang.Class<? extends java.lang.Throwable> type)