Package org.apache.mina.filter.codec
Filter implementations that helps you to implement complex protocols via 'codec' concept.
- Author:
- Apache MINA Project
-
Interface Summary Interface Description ProtocolCodecFactory ProvidesProtocolEncoder
andProtocolDecoder
which translates binary or protocol specific data into message object and vice versa.ProtocolDecoder Decodes binary or protocol-specific data into higher-level message objects.ProtocolDecoderOutput Callback forProtocolDecoder
to generate decoded messages.ProtocolEncoder Encodes higher-level message objects into binary or protocol-specific data.ProtocolEncoderOutput Callback forProtocolEncoder
to generate encoded messages such asIoBuffer
s. -
Class Summary Class Description AbstractProtocolDecoderOutput AProtocolDecoderOutput
based on queue.AbstractProtocolEncoderOutput AProtocolEncoderOutput
based on queue.CumulativeProtocolDecoder AProtocolDecoder
that cumulates the content of received buffers to a cumulative buffer to help users implement decoders.ProtocolCodecFilter AnIoFilter
which translates binary or protocol specific data into message objects and vice versa usingProtocolCodecFactory
,ProtocolEncoder
, orProtocolDecoder
.ProtocolCodecSession ProtocolDecoderAdapter An abstractProtocolDecoder
implementation for those who don't needProtocolDecoder.finishDecode(IoSession, ProtocolDecoderOutput)
norProtocolDecoder.dispose(IoSession)
method.ProtocolEncoderAdapter An abstractProtocolEncoder
implementation for those who don't have any resources to dispose.SynchronizedProtocolDecoder AProtocolDecoder
implementation which decorates an existing decoder to be thread-safe.SynchronizedProtocolEncoder AProtocolEncoder
implementation which decorates an existing encoder to be thread-safe. -
Exception Summary Exception Description ProtocolCodecException An exception that is thrown whenProtocolEncoder
orProtocolDecoder
cannot understand or failed to validate data to process.ProtocolDecoderException An exception that is thrown whenProtocolDecoder
cannot understand or failed to validate the specifiedIoBuffer
content.ProtocolEncoderException An exception that is thrown whenProtocolEncoder
cannot understand or failed to validate the specified message object.RecoverableProtocolDecoderException A special exception that tells theProtocolDecoder
can keep decoding even after this exception is thrown.