io.netty.handler.codec

Class MessageToByteEncoder<I>

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

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

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelOutboundHandler

Direct Known Subclasses:

CompatibleMarshallingEncoder, CompatibleObjectEncoder, LengthFieldPrepender, MarshallingEncoder, ObjectEncoder, ProtobufVarint32LengthFieldPrepender, SnappyFramedEncoder, StringEncoder, ZlibEncoder

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

ChannelOutboundHandlerAdapter 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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acceptOutboundMessage(Object msg)
protected abstract void	encode(io.netty.channel.ChannelHandlerContext ctx, I msg, io.netty.buffer.ByteBuf out) Encode a message into a ByteBuf.
void	write(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.MessageList<Object> msgs, io.netty.channel.ChannelPromise promise)

Methods inherited from class io.netty.channel.ChannelOutboundHandlerAdapter

bind, close, connect, deregister, disconnect, read

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

exceptionCaught, handlerAdded, handlerRemoved

Constructor Detail

MessageToByteEncoder

protected MessageToByteEncoder()

MessageToByteEncoder

protected MessageToByteEncoder(Class<? extends I> outboundMessageType)

MessageToByteEncoder

protected MessageToByteEncoder(boolean preferDirect)

MessageToByteEncoder

protected MessageToByteEncoder(Class<? extends I> outboundMessageType,
                    boolean preferDirect)

Method Detail

acceptOutboundMessage

public boolean acceptOutboundMessage(Object msg)
                              throws Exception

Throws:

Exception

write

public void write(io.netty.channel.ChannelHandlerContext ctx,
         io.netty.channel.MessageList<Object> msgs,
         io.netty.channel.ChannelPromise promise)
           throws Exception

Specified by:

write in interface io.netty.channel.ChannelOutboundHandler

Overrides:

write in class io.netty.channel.ChannelOutboundHandlerAdapter

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 MessageList 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