org.apache.mina.filter.codec

Interface ProtocolDecoder

Known Implementing Classes:
CumulativeProtocolDecoder, ObjectSerializationDecoder, ProtocolDecoderAdapter, SynchronizedProtocolDecoder, TextLineDecoder

public interface ProtocolDecoder

Decodes binary or protocol-specific data into higher-level message objects. MINA invokes decode(IoSession,ByteBuffer,ProtocolDecoderOutput) method with read data, and then the decoder implementation puts decoded messages into ProtocolDecoderOutput by calling ProtocolDecoderOutput.write(Object).

Please refer to TextLineDecoder example.

Method Summary

void
decode(IoSession session, ByteBuffer in, ProtocolDecoderOutput out)
Decodes binary or protocol-specific content into higher-level message objects.
void
dispose(IoSession session)
Releases all resources related with this decoder.
void
finishDecode(IoSession session, ProtocolDecoderOutput out)
Invoked when the specified session is closed.

Method Details

decode

public void decode(IoSession session,
                   ByteBuffer in,
                   ProtocolDecoderOutput out)
            throws Exception
Decodes binary or protocol-specific content into higher-level message objects. MINA invokes decode(IoSession,ByteBuffer,ProtocolDecoderOutput) method with read data, and then the decoder implementation puts decoded messages into ProtocolDecoderOutput.

dispose

public void dispose(IoSession session)
            throws Exception
Releases all resources related with this decoder.

finishDecode

public void finishDecode(IoSession session,
                         ProtocolDecoderOutput out)
            throws Exception
Invoked when the specified session is closed. This method is useful when you deal with the protocol which doesn't specify the length of a message such as HTTP response without content-length header. Implement this method to process the remaining data that decode(IoSession,ByteBuffer,ProtocolDecoderOutput) method didn't process completely.