org.apache.mina.filter.codec

类 ProtocolCodecFilter

java.lang.Object

org.apache.mina.core.filterchain.IoFilterAdapter

org.apache.mina.filter.codec.ProtocolCodecFilter

所有已实现的接口:

IoFilter

直接已知子类:

HttpClientCodec, HttpServerCodec

public class ProtocolCodecFilter
extends IoFilterAdapter

An IoFilter which translates binary or protocol specific data into message objects and vice versa using ProtocolCodecFactory, ProtocolEncoder, or ProtocolDecoder.

作者:

Apache MINA Project

嵌套类概要

从接口继承的嵌套类/接口 org.apache.mina.core.filterchain.IoFilter

IoFilter.NextFilter

构造器概要

构造器

构造器和说明
ProtocolCodecFilter(java.lang.Class<? extends ProtocolEncoder> encoderClass, java.lang.Class<? extends ProtocolDecoder> decoderClass) Creates a new instance of ProtocolCodecFilter, without any factory.
ProtocolCodecFilter(ProtocolCodecFactory factory) Creates a new instance of ProtocolCodecFilter, associating a factory for the creation of the encoder and decoder.
ProtocolCodecFilter(ProtocolEncoder encoder, ProtocolDecoder decoder) Creates a new instance of ProtocolCodecFilter, without any factory.

方法概要

方法

限定符和类型	方法和说明
void	filterWrite(IoFilter.NextFilter nextFilter, IoSession session, WriteRequest writeRequest) Filters IoSession.write(Object) method invocation.
ProtocolEncoder	getEncoder(IoSession session) Get the encoder instance from a given session.
void	messageReceived(IoFilter.NextFilter nextFilter, IoSession session, java.lang.Object message) Process the incoming message, calling the session decoder.
void	messageSent(IoFilter.NextFilter nextFilter, IoSession session, WriteRequest writeRequest) Filters IoHandler.messageSent(IoSession,Object) event.
void	onPostRemove(IoFilterChain parent, java.lang.String name, IoFilter.NextFilter nextFilter) Invoked after this filter is removed from the specified parent.
void	onPreAdd(IoFilterChain parent, java.lang.String name, IoFilter.NextFilter nextFilter) Invoked before this filter is added to the specified parent.
void	sessionClosed(IoFilter.NextFilter nextFilter, IoSession session) Filters IoHandler.sessionClosed(IoSession) event.

从类继承的方法 org.apache.mina.core.filterchain.IoFilterAdapter

destroy, exceptionCaught, filterClose, init, inputClosed, onPostAdd, onPreRemove, sessionCreated, sessionIdle, sessionOpened, toString

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

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

构造器详细资料

ProtocolCodecFilter

public ProtocolCodecFilter(ProtocolCodecFactory factory)

Creates a new instance of ProtocolCodecFilter, associating a factory for the creation of the encoder and decoder.

参数:

factory - The associated factory

ProtocolCodecFilter

public ProtocolCodecFilter(ProtocolEncoder encoder,
                   ProtocolDecoder decoder)

Creates a new instance of ProtocolCodecFilter, without any factory. The encoder/decoder factory will be created as an inner class, using the two parameters (encoder and decoder).

参数:

encoder - The class responsible for encoding the message

decoder - The class responsible for decoding the message

ProtocolCodecFilter

public ProtocolCodecFilter(java.lang.Class<? extends ProtocolEncoder> encoderClass,
                   java.lang.Class<? extends ProtocolDecoder> decoderClass)

Creates a new instance of ProtocolCodecFilter, without any factory. The encoder/decoder factory will be created as an inner class, using the two parameters (encoder and decoder), which are class names. Instances for those classes will be created in this constructor.

参数:

encoderClass - The class responsible for encoding the message

decoderClass - The class responsible for decoding the message

方法详细资料

getEncoder

public ProtocolEncoder getEncoder(IoSession session)

Get the encoder instance from a given session.

参数:

session - The associated session we will get the encoder from

返回:

The encoder instance, if any

onPreAdd

public void onPreAdd(IoFilterChain parent,
            java.lang.String name,
            IoFilter.NextFilter nextFilter)
              throws java.lang.Exception

从类复制的说明: IoFilterAdapter

Invoked before this filter is added to the specified parent. Please note that this method can be invoked more than once if this filter is added to more than one parents. This method is not invoked before IoFilter.init() is invoked.

指定者:

onPreAdd 在接口中 IoFilter

覆盖:

onPreAdd 在类中 IoFilterAdapter

参数:

parent - the parent who called this method

name - the name assigned to this filter

nextFilter - the IoFilter.NextFilter for this filter. You can reuse this object until this filter is removed from the chain.

抛出:

java.lang.Exception - If an error occurred while processing the event

onPostRemove

public void onPostRemove(IoFilterChain parent,
                java.lang.String name,
                IoFilter.NextFilter nextFilter)
                  throws java.lang.Exception

从类复制的说明: IoFilterAdapter

Invoked after this filter is removed from the specified parent. Please note that this method can be invoked more than once if this filter is removed from more than one parents. This method is always invoked before IoFilter.destroy() is invoked.

指定者:

onPostRemove 在接口中 IoFilter

覆盖:

onPostRemove 在类中 IoFilterAdapter

参数:

parent - the parent who called this method

name - the name assigned to this filter

nextFilter - the IoFilter.NextFilter for this filter. You can reuse this object until this filter is removed from the chain.

抛出:

java.lang.Exception - If an error occurred while processing the event

messageReceived

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

Process the incoming message, calling the session decoder. As the incoming buffer might contains more than one messages, we have to loop until the decoder throws an exception. while ( buffer not empty ) try decode ( buffer ) catch break;

指定者:

messageReceived 在接口中 IoFilter

覆盖:

messageReceived 在类中 IoFilterAdapter

参数:

nextFilter - the IoFilter.NextFilter for this filter. You can reuse this object until this filter is removed from the chain.

session - The IoSession which has received this event

message - The received message

抛出:

java.lang.Exception - If an error occurred while processing the event

messageSent

public void messageSent(IoFilter.NextFilter nextFilter,
               IoSession session,
               WriteRequest writeRequest)
                 throws java.lang.Exception

从类复制的说明: IoFilterAdapter

Filters IoHandler.messageSent(IoSession,Object) event.

指定者:

messageSent 在接口中 IoFilter

覆盖:

messageSent 在类中 IoFilterAdapter

参数:

nextFilter - the IoFilter.NextFilter for this filter. You can reuse this object until this filter is removed from the chain.

session - The IoSession which has received this event

writeRequest - The WriteRequest that contains the sent message

抛出:

java.lang.Exception - If an error occurred while processing the event

filterWrite

public void filterWrite(IoFilter.NextFilter nextFilter,
               IoSession session,
               WriteRequest writeRequest)
                 throws java.lang.Exception

从类复制的说明: IoFilterAdapter

Filters IoSession.write(Object) method invocation.

指定者:

filterWrite 在接口中 IoFilter

覆盖:

filterWrite 在类中 IoFilterAdapter

参数:

nextFilter - the IoFilter.NextFilter for this filter. You can reuse this object until this filter is removed from the chain.

session - The IoSession which has to process this invocation

writeRequest - The WriteRequest to process

抛出:

java.lang.Exception - If an error occurred while processing the event

sessionClosed

public void sessionClosed(IoFilter.NextFilter nextFilter,
                 IoSession session)
                   throws java.lang.Exception

从类复制的说明: IoFilterAdapter

Filters IoHandler.sessionClosed(IoSession) event.

指定者:

sessionClosed 在接口中 IoFilter

覆盖:

sessionClosed 在类中 IoFilterAdapter

参数:

nextFilter - the IoFilter.NextFilter for this filter. You can reuse this object until this filter is removed from the chain.

session - The IoSession which has received this event

抛出:

java.lang.Exception - If an error occurred while processing the event