ProtocolEncoder

All Known Implementing Classes:

ObjectSerializationEncoder, ProtocolEncoderAdapter, SynchronizedProtocolEncoder, TextLineEncoder
```
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.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`dispose(IoSession session)`	Releases all resources related with this encoder.
`void`	`encode(IoSession session, java.lang.Object message, ProtocolEncoderOutput out)`	Encodes higher-level message objects into binary or protocol-specific data.

- Method Detail
  - encode
```
void encode(IoSession session,
            java.lang.Object message,
            ProtocolEncoderOutput out)
     throws java.lang.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:
    
    java.lang.Exception - if the message violated protocol specification
  - dispose
```
void dispose(IoSession session)
      throws java.lang.Exception
```
    Releases all resources related with this encoder.
    
    Throws:
    
    java.lang.Exception - if failed to dispose all resources