io.netty.handler.codec

Class ByteToMessageCodec<I>

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

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

All Implemented Interfaces:

ChannelHandler

public abstract class ByteToMessageCodec<I>
extends ChannelHandlerAdapter

A Codec for on-the-fly encoding/decoding of bytes to messages and vise-versa. This can be thought of as a combination of ByteToMessageDecoder and MessageToByteEncoder. Be aware that sub-classes of ByteToMessageCodec MUST NOT annotated with @Sharable.

Nested Class Summary

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

ChannelHandler.Sharable, ChannelHandler.Skip

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ByteToMessageCodec()
protected	ByteToMessageCodec(boolean preferDirect) Create a new instance which will try to detect the types to match out of the type parameter of the class.
protected	ByteToMessageCodec(Class<? extends I> outboundMessageType)
protected	ByteToMessageCodec(Class<? extends I> outboundMessageType, boolean preferDirect) Create a new instance

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acceptOutboundMessage(Object msg) Returns true if and only if the specified message can be encoded by this codec.
void	channelRead(ChannelHandlerContext ctx, Object msg) Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelHandler in the ChannelPipeline.
protected abstract void	decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out)
protected void	decodeLast(ChannelHandlerContext ctx, ByteBuf in, List<Object> out)
protected abstract void	encode(ChannelHandlerContext ctx, I msg, ByteBuf out)
void	write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) Calls ChannelHandlerContext.write(Object) to forward to the next ChannelHandler in the ChannelPipeline.

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

bind, channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, close, connect, deregister, disconnect, exceptionCaught, flush, handlerAdded, handlerRemoved, isSharable, read, userEventTriggered

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteToMessageCodec

protected ByteToMessageCodec()

See Also:

#ByteToMessageCodec(boolean)} with {@code true} as boolean parameter.

ByteToMessageCodec

protected ByteToMessageCodec(Class<? extends I> outboundMessageType)

See Also:

#ByteToMessageCodec(Class, boolean)} with {@code true} as boolean value.

ByteToMessageCodec

protected ByteToMessageCodec(boolean preferDirect)

Create a new instance which will try to detect the types to match out of the type parameter of the class.

Parameters:

preferDirect - true if a direct ByteBuf should be tried to be used as target for the encoded messages. If false is used it will allocate a heap ByteBuf, which is backed by an byte array.

ByteToMessageCodec

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

Create a new instance

Parameters:

outboundMessageType - The type of messages to match

preferDirect - true if a direct ByteBuf should be tried to be used as target for the encoded messages. If false is used it will allocate a heap ByteBuf, which is backed by an byte array.

Method Detail

acceptOutboundMessage

public boolean acceptOutboundMessage(Object msg)
                              throws Exception

Returns true if and only if the specified message can be encoded by this codec.

Parameters:

msg - the message

Throws:

Exception

channelRead

public void channelRead(ChannelHandlerContext ctx,
               Object msg)
                 throws Exception

Description copied from class: ChannelHandlerAdapter

Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

channelRead in interface ChannelHandler

Overrides:

channelRead in class ChannelHandlerAdapter

Throws:

Exception

write

public void write(ChannelHandlerContext ctx,
         Object msg,
         ChannelPromise promise)
           throws Exception

Description copied from class: ChannelHandlerAdapter

Calls ChannelHandlerContext.write(Object) to forward to the next ChannelHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

write in interface ChannelHandler

Overrides:

write in class ChannelHandlerAdapter

Parameters:

ctx - the ChannelHandlerContext for which the write operation is made

msg - the message to write

promise - the ChannelPromise to notify once the operation completes

Throws:

Exception - thrown if an error accour

encode

protected abstract void encode(ChannelHandlerContext ctx,
          I msg,
          ByteBuf out)
                        throws Exception

Throws:

Exception

See Also:

MessageToByteEncoder.encode(ChannelHandlerContext, Object, ByteBuf)

decode

protected abstract void decode(ChannelHandlerContext ctx,
          ByteBuf in,
          List<Object> out)
                        throws Exception

Throws:

Exception

See Also:

ByteToMessageDecoder.decode(ChannelHandlerContext, ByteBuf, List)

decodeLast

protected void decodeLast(ChannelHandlerContext ctx,
              ByteBuf in,
              List<Object> out)
                   throws Exception

Throws:

Exception

See Also:

ByteToMessageDecoder.decodeLast(ChannelHandlerContext, ByteBuf, List)