io.netty.handler.codec

Class MessageToByteEncoder<I>

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOperationHandlerAdapter

io.netty.channel.ChannelOutboundMessageHandlerAdapter<I>

io.netty.handler.codec.MessageToByteEncoder<I>

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelHandlerUtil.SingleOutboundMessageHandler<I>, io.netty.channel.ChannelOperationHandler, io.netty.channel.ChannelOutboundMessageHandler<I>

Direct Known Subclasses:

CompatibleMarshallingEncoder, CompatibleObjectEncoder, LengthFieldPrepender, MarshallingEncoder, ObjectEncoder, ProtobufVarint32LengthFieldPrepender

public abstract class MessageToByteEncoder<I>
extends io.netty.channel.ChannelOutboundMessageHandlerAdapter<I>

ChannelOutboundMessageHandlerAdapter which encodes message in a stream-like fashion from one message to an ByteBuf. Example implementation which encodes Integers to a ByteBuf.

     public class IntegerEncoder extends MessageToByteEncoder<Integer> {
         @Override
         public void encode(ChannelHandlerContext ctx, Integer msg, ByteBuf out)
                 throws Exception {
             out.writeInt(msg);
         }
     }
 

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields inherited from class io.netty.channel.ChannelOutboundMessageHandlerAdapter

ABORT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MessageToByteEncoder()
protected	MessageToByteEncoder(Class<? extends I> outboundMessageType)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	encode(io.netty.channel.ChannelHandlerContext ctx, I msg, io.netty.buffer.ByteBuf out) Encode a message into a ByteBuf.
void	flush(io.netty.channel.ChannelHandlerContext ctx, I msg)

Methods inherited from class io.netty.channel.ChannelOutboundMessageHandlerAdapter

acceptOutboundMessage, beginFlush, endFlush, flush, isCloseOnFailedFlush, newOutboundBuffer, setCloseOnFailedFlush

Methods inherited from class io.netty.channel.ChannelOperationHandlerAdapter

bind, close, connect, deregister, disconnect, read, sendFile

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

exceptionCaught, handlerAdded, handlerRemoved

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.netty.channel.ChannelOperationHandler

bind, close, connect, deregister, disconnect, read, sendFile

Methods inherited from interface io.netty.channel.ChannelHandler

exceptionCaught, handlerAdded, handlerRemoved

Constructor Detail

MessageToByteEncoder

protected MessageToByteEncoder()

MessageToByteEncoder

protected MessageToByteEncoder(Class<? extends I> outboundMessageType)

Method Detail

flush

public void flush(io.netty.channel.ChannelHandlerContext ctx,
         I msg)
           throws Exception

Throws:

Exception

encode

protected abstract void encode(io.netty.channel.ChannelHandlerContext ctx,
          I msg,
          io.netty.buffer.ByteBuf out)
                        throws Exception

Encode a message into a ByteBuf. This method will be called till the MessageBuf has nothing left.

Parameters:

ctx - the ChannelHandlerContext which this MessageToByteEncoder belongs to

msg - the message to encode

out - the ByteBuf into which the encoded message will be written

Throws:

Exception - is thrown if an error accour