Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.mina.filter.codec
Interface ProtocolDecoder

All Known Implementing Classes:
  CumulativeProtocolDecoder, NettyDecoder, 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.

Version:
  $Rev: 555855 $, $Date: 2007-07-13 05:19:00 +0200 (Fri, 13 Jul 2007) $
Author:
  The Apache Directory Project (mina-dev@directory.apache.org)

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 Detail

### decode

    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`.

  Throws:
    `Exception` - if the read data violated protocol specification

### finishDecode

    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.

  Throws:
    `Exception` - if the read data violated protocol specification

### dispose

    void dispose(IoSession session)
                 throws Exception

  Releases all resources related with this decoder.

  Throws:
    `Exception` - if failed to dispose all resources

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2004-2008 Apache MINA Project. All Rights Reserved.