Class ByteToMessageCodec.Encoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

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

io.netty.handler.codec.ByteToMessageCodec.Encoder

All Implemented Interfaces:

ChannelHandler, ChannelOutboundHandler

Enclosing class:

ByteToMessageCodec<I>

private final class ByteToMessageCodec.Encoder
extends MessageToByteEncoder<I>

Nested Class Summary

Nested classes/interfaces inherited from interface ChannelHandler

ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor	Description
Encoder(boolean preferDirect)
Encoder(boolean preferDirect, java.lang.Class<? extends I> outboundMessageType)

Method Summary

Modifier and Type	Method	Description
boolean	acceptOutboundMessage(java.lang.Object msg)	Returns true if the given message should be handled.
protected void	encode(ChannelHandlerContext ctx, I msg, ByteBuf out)	Encode a message into a ByteBuf.

Methods inherited from class MessageToByteEncoder

allocateBuffer, isPreferDirect, write

Methods inherited from class ChannelOutboundHandlerAdapter

bind, close, connect, deregister, disconnect, flush, read

Methods inherited from class ChannelHandlerAdapter

ensureNotSharable, exceptionCaught, handlerAdded, handlerRemoved, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface ChannelHandler

exceptionCaught, handlerAdded, handlerRemoved

Constructor Details

Encoder

Encoder(boolean preferDirect)

Encoder

Encoder(boolean preferDirect,
 java.lang.Class<? extends I> outboundMessageType)

Method Details

acceptOutboundMessage

public boolean acceptOutboundMessage(java.lang.Object msg)
                              throws java.lang.Exception

Description copied from class: MessageToByteEncoder

Returns true if the given message should be handled. If false it will be passed to the next ChannelOutboundHandler in the ChannelPipeline.

Overrides:

acceptOutboundMessage in class MessageToByteEncoder<I>

Throws:

java.lang.Exception

encode

protected void encode(ChannelHandlerContext ctx,
 I msg,
 ByteBuf out)
               throws java.lang.Exception

Description copied from class: MessageToByteEncoder

Encode a message into a ByteBuf. This method will be called for each written message that can be handled by this encoder.

Specified by:

encode in class MessageToByteEncoder<I>

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:

java.lang.Exception - is thrown if an error occurs