org.apache.mina.filter.codec
Interface ProtocolEncoder

All Known Implementing Classes:
NettyEncoder, ProtocolEncoderAdapter, SynchronizedProtocolEncoder

public interface ProtocolEncoder

Encodes higher-level message objects into binary or protocol-specific data. MINA invokes encode(IoSession, Object, ProtocolEncoderOutput) method with message which is popped from the session write queue, and then the encoder implementation puts encoded ByteBuffers into ProtocolEncoderOutput by calling ProtocolEncoderOutput.write(ByteBuffer).

Please refer to TextLineEncoder example.

Version:
$Rev: 436993 $, $Date: 2006-08-26 00:36:56 +0200 (Sat, 26 Aug 2006) $
Author:
The Apache Directory Project (mina-dev@directory.apache.org)

Method Summary
 void dispose(IoSession session)
          Releases all resources related with this encoder.
 void encode(IoSession session, Object message, ProtocolEncoderOutput out)
          Encodes higher-level message objects into binary or protocol-specific data.
 

Method Detail

encode

public void encode(IoSession session,
                   Object message,
                   ProtocolEncoderOutput out)
            throws Exception
Encodes higher-level message objects into binary or protocol-specific data. MINA invokes encode(IoSession, Object, ProtocolEncoderOutput) method with message which is popped from the session write queue, and then the encoder implementation puts encoded ByteBuffers into ProtocolEncoderOutput.

Throws:
Exception - if the message violated protocol specification

dispose

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

Throws:
Exception - if failed to dispose all resources