org.apache.mina.protocol

Interface ProtocolDecoder

All Known Implementing Classes:

CumulativeProtocolDecoder

public interface ProtocolDecoder

Decodes binary or protocol-specific data into higher-level message objects. MINA invokes decode(ProtocolSession, 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.

Version:

$Rev: 326586 $, $Date: 2005-10-19 17:50:29 +0200 (Wed, 19 Oct 2005) $

Author:

The Apache Directory Project (dev@directory.apache.org)

Method Summary

Modifier and Type	Method and Description
void	decode(ProtocolSession session, ByteBuffer in, ProtocolDecoderOutput out) Decodes binary or protocol-specific content into higher-level message objects.

Method Detail

decode

void decode(ProtocolSession session,
            ByteBuffer in,
            ProtocolDecoderOutput out)
     throws ProtocolViolationException

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

Throws:

ProtocolViolationException - if the read data violated protocol specification