org.apache.mina.filter.codec.demux

Interface MessageEncoder<T>

All Known Implementing Classes:

AbstractMessageEncoder, AddMessageEncoder, ResultMessageEncoder

public interface MessageEncoder<T>

Encodes a certain type of messages.

We didn't provide any dispose method for MessageEncoder because it can give you performance penalty in case you have a lot of message types to handle.

Author:

Apache MINA Project

See Also:

DemuxingProtocolEncoder, MessageEncoderFactory

Method Summary

Methods

Modifier and Type	Method and Description
void	encode(IoSession session, T message, ProtocolEncoderOutput out) Encodes higher-level message objects into binary or protocol-specific data.

Method Detail

encode

void encode(IoSession session,
          T 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 IoBuffers into ProtocolEncoderOutput.

Parameters:

session - The current session

message - The message to encode

out - The instance of ProtocolEncoderOutput that will receive the encoded message

Throws:

Exception - if the message violated protocol specification