|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.mina.common.IoFilterAdapter
org.apache.mina.filter.codec.ProtocolCodecFilter
public class ProtocolCodecFilter
An IoFilter which translates binary or protocol specific data into
message object and vice versa using ProtocolCodecFactory,
ProtocolEncoder, or ProtocolDecoder.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from interface org.apache.mina.common.IoFilter |
|---|
IoFilter.NextFilter, IoFilter.WriteRequest |
| Field Summary | |
|---|---|
static String |
DECODER
|
static String |
ENCODER
|
| Constructor Summary | |
|---|---|
ProtocolCodecFilter(Class<? extends ProtocolEncoder> encoderClass,
Class<? extends ProtocolDecoder> decoderClass)
|
|
ProtocolCodecFilter(ProtocolCodecFactory factory)
|
|
ProtocolCodecFilter(ProtocolEncoder encoder,
ProtocolDecoder decoder)
|
|
| Method Summary | |
|---|---|
void |
filterWrite(IoFilter.NextFilter nextFilter,
IoSession session,
IoFilter.WriteRequest writeRequest)
Filters IoSession.write(Object) method invocation. |
void |
messageReceived(IoFilter.NextFilter nextFilter,
IoSession session,
Object message)
Filters IoHandler.messageReceived(IoSession,Object)
event. |
void |
messageSent(IoFilter.NextFilter nextFilter,
IoSession session,
Object message)
Filters IoHandler.messageSent(IoSession,Object)
event. |
void |
onPostRemove(IoFilterChain parent,
String name,
IoFilter.NextFilter nextFilter)
Invoked after this filter is removed from the specified parent. |
void |
onPreAdd(IoFilterChain parent,
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. |
| Methods inherited from class org.apache.mina.common.IoFilterAdapter |
|---|
destroy, exceptionCaught, filterClose, init, onPostAdd, onPreRemove, sessionCreated, sessionIdle, sessionOpened |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final String ENCODER
public static final String DECODER
| Constructor Detail |
|---|
public ProtocolCodecFilter(ProtocolCodecFactory factory)
public ProtocolCodecFilter(ProtocolEncoder encoder,
ProtocolDecoder decoder)
public ProtocolCodecFilter(Class<? extends ProtocolEncoder> encoderClass,
Class<? extends ProtocolDecoder> decoderClass)
| Method Detail |
|---|
public void onPreAdd(IoFilterChain parent,
String name,
IoFilter.NextFilter nextFilter)
throws Exception
IoFilterIoFilter.init() is invoked.
onPreAdd in interface IoFilteronPreAdd in class IoFilterAdapterparent - the parent who called this methodname - the name assigned to this filternextFilter - the IoFilter.NextFilter for this filter. You can reuse
this object until this filter is removed from the chain.
Exception
public void onPostRemove(IoFilterChain parent,
String name,
IoFilter.NextFilter nextFilter)
throws Exception
IoFilterIoFilter.destroy() is invoked.
onPostRemove in interface IoFilteronPostRemove in class IoFilterAdapterparent - the parent who called this methodname - the name assigned to this filternextFilter - the IoFilter.NextFilter for this filter. You can reuse
this object until this filter is removed from the chain.
Exception
public void messageReceived(IoFilter.NextFilter nextFilter,
IoSession session,
Object message)
throws Exception
IoFilterIoHandler.messageReceived(IoSession,Object)
event.
messageReceived in interface IoFiltermessageReceived in class IoFilterAdapterException
public void messageSent(IoFilter.NextFilter nextFilter,
IoSession session,
Object message)
throws Exception
IoFilterIoHandler.messageSent(IoSession,Object)
event.
messageSent in interface IoFiltermessageSent in class IoFilterAdapterException
public void filterWrite(IoFilter.NextFilter nextFilter,
IoSession session,
IoFilter.WriteRequest writeRequest)
throws Exception
IoFilterIoSession.write(Object) method invocation.
filterWrite in interface IoFilterfilterWrite in class IoFilterAdapterException
public void sessionClosed(IoFilter.NextFilter nextFilter,
IoSession session)
throws Exception
IoFilterIoHandler.sessionClosed(IoSession) event.
sessionClosed in interface IoFiltersessionClosed in class IoFilterAdapterException
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||