io.netty.handler.codec

Class ByteToMessageCodec<I>

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelDuplexHandler

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

All Implemented Interfaces:

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

public abstract class ByteToMessageCodec<I>
extends io.netty.channel.ChannelDuplexHandler

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

io.netty.channel.ChannelHandler.Sharable

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(io.netty.channel.ChannelHandlerContext ctx, Object msg)
protected abstract void	decode(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf in, List<Object> out)
protected void	decodeLast(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf in, List<Object> out)
protected abstract void	encode(io.netty.channel.ChannelHandlerContext ctx, I msg, io.netty.buffer.ByteBuf out)
void	write(io.netty.channel.ChannelHandlerContext ctx, Object msg, io.netty.channel.ChannelPromise promise)

Methods inherited from class io.netty.channel.ChannelDuplexHandler

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

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

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 io.netty.channel.ChannelHandler

exceptionCaught, handlerAdded, handlerRemoved

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(io.netty.channel.ChannelHandlerContext ctx,
               Object msg)
                 throws Exception

Specified by:

channelRead in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelRead in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception

write

public void write(io.netty.channel.ChannelHandlerContext ctx,
         Object msg,
         io.netty.channel.ChannelPromise promise)
           throws Exception

Specified by:

write in interface io.netty.channel.ChannelOutboundHandler

Overrides:

write in class io.netty.channel.ChannelDuplexHandler

Throws:

Exception

encode

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

Throws:

Exception

See Also:

MessageToByteEncoder.encode(ChannelHandlerContext, Object, ByteBuf)

decode

protected abstract void decode(io.netty.channel.ChannelHandlerContext ctx,
          io.netty.buffer.ByteBuf in,
          List<Object> out)
                        throws Exception

Throws:

Exception

See Also:

ByteToMessageDecoder.decode(ChannelHandlerContext, ByteBuf, List)

decodeLast

protected void decodeLast(io.netty.channel.ChannelHandlerContext ctx,
              io.netty.buffer.ByteBuf in,
              List<Object> out)
                   throws Exception

Throws:

Exception

See Also:

ByteToMessageDecoder.decodeLast(ChannelHandlerContext, ByteBuf, List)