io.netty.handler.codec

Class ByteToMessageCodec<I>

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelStateHandlerAdapter

io.netty.channel.ChannelDuplexHandler

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

All Implemented Interfaces:

ChannelHandler, ChannelInboundByteHandler, ChannelOperationHandler, ChannelOutboundMessageHandler<I>, ChannelStateHandler

public abstract class ByteToMessageCodec<I>
extends ChannelDuplexHandler
implements ChannelInboundByteHandler, ChannelOutboundMessageHandler<I>

Nested Class Summary

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

ChannelHandler.Sharable

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ByteToMessageCodec()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acceptOutboundMessage(Object msg)
void	beforeAdd(ChannelHandlerContext ctx) Do nothing by default, sub-classes may override this method.
protected abstract Object	decode(ChannelHandlerContext ctx, ByteBuf in)
protected Object	decodeLast(ChannelHandlerContext ctx, ByteBuf in)
void	discardInboundReadBytes(ChannelHandlerContext ctx) Discards the read bytes of the inbound buffer and optionally trims its unused portion to reduce memory consumption.
protected abstract void	encode(ChannelHandlerContext ctx, I msg, ByteBuf out)
void	flush(ChannelHandlerContext ctx, ChannelPromise promise) Called once a flush operation is made and so the outbound data should be written.
void	freeInboundBuffer(ChannelHandlerContext ctx) Invoked when this handler is not going to receive any inbound message anymore and thus it's safe to deallocate its inbound buffer.
void	freeOutboundBuffer(ChannelHandlerContext ctx) Invoked when this handler is not allowed to send any outbound message anymore and thus it's safe to deallocate its outbound buffer.
void	inboundBufferUpdated(ChannelHandlerContext ctx) The inbound buffer of the ChannelHandlerContext was updated with new data.
ByteBuf	newInboundBuffer(ChannelHandlerContext ctx) Return the ByteBuf which will be used for inbound data for the given ChannelHandlerContext.
MessageBuf<I>	newOutboundBuffer(ChannelHandlerContext ctx) Return the Buf which will be used for outbound data for the given ChannelHandlerContext.

Methods inherited from class io.netty.channel.ChannelDuplexHandler

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

Methods inherited from class io.netty.channel.ChannelStateHandlerAdapter

channelActive, channelInactive, channelReadSuspended, channelRegistered, channelUnregistered, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

afterAdd, afterRemove, beforeRemove, exceptionCaught

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

channelActive, channelInactive, channelReadSuspended, channelRegistered, channelUnregistered, userEventTriggered

Methods inherited from interface io.netty.channel.ChannelOperationHandler

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

Methods inherited from interface io.netty.channel.ChannelHandler

afterAdd, afterRemove, beforeRemove, exceptionCaught

Constructor Detail

ByteToMessageCodec

protected ByteToMessageCodec()

Method Detail

beforeAdd

public void beforeAdd(ChannelHandlerContext ctx)
               throws Exception

Description copied from class: ChannelHandlerAdapter

Do nothing by default, sub-classes may override this method.

Specified by:

beforeAdd in interface ChannelHandler

Overrides:

beforeAdd in class ChannelHandlerAdapter

Throws:

Exception

newInboundBuffer

public ByteBuf newInboundBuffer(ChannelHandlerContext ctx)
                         throws Exception

Description copied from interface: ChannelInboundByteHandler

Return the ByteBuf which will be used for inbound data for the given ChannelHandlerContext. Implementations should take ChannelConfig.getDefaultHandlerByteBufType() into account.

Use of ChannelHandlerUtil.allocate(ChannelHandlerContext) is adviced.

Specified by:

newInboundBuffer in interface ChannelInboundByteHandler

Throws:

Exception

discardInboundReadBytes

public void discardInboundReadBytes(ChannelHandlerContext ctx)
                             throws Exception

Description copied from interface: ChannelInboundByteHandler

Discards the read bytes of the inbound buffer and optionally trims its unused portion to reduce memory consumption. The most common implementation of this method will look like the following:

     ctx.inboundByteBuffer().discardSomeReadBytes();
 

Specified by:

discardInboundReadBytes in interface ChannelInboundByteHandler

Throws:

Exception

freeInboundBuffer

public void freeInboundBuffer(ChannelHandlerContext ctx)
                       throws Exception

Invoked when this handler is not going to receive any inbound message anymore and thus it's safe to deallocate its inbound buffer.

Throws:

Exception

newOutboundBuffer

public MessageBuf<I> newOutboundBuffer(ChannelHandlerContext ctx)
                                throws Exception

Return the Buf which will be used for outbound data for the given ChannelHandlerContext.

Specified by:

newOutboundBuffer in interface ChannelOutboundMessageHandler<I>

Throws:

Exception

freeOutboundBuffer

public void freeOutboundBuffer(ChannelHandlerContext ctx)
                        throws Exception

Invoked when this handler is not allowed to send any outbound message anymore and thus it's safe to deallocate its outbound buffer.

Throws:

Exception

inboundBufferUpdated

public void inboundBufferUpdated(ChannelHandlerContext ctx)
                          throws Exception

Description copied from interface: ChannelStateHandler

The inbound buffer of the ChannelHandlerContext was updated with new data. This means something may be ready to get processed by the actual ChannelStateHandler implementation. It's up to the implementation to consume it or keep it in the buffer to wait for more data and consume it later.

Specified by:

inboundBufferUpdated in interface ChannelStateHandler

Throws:

Exception

flush

public void flush(ChannelHandlerContext ctx,
         ChannelPromise promise)
           throws Exception

Description copied from interface: ChannelOperationHandler

Called once a flush operation is made and so the outbound data should be written.

Specified by:

flush in interface ChannelOperationHandler

Parameters:

ctx - the ChannelHandlerContext for which the flush operation is made

promise - the ChannelPromise to notify once the operation completes

Throws:

Exception - thrown if an error accour

acceptOutboundMessage

public boolean acceptOutboundMessage(Object msg)
                              throws Exception

Throws:

Exception

encode

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

Throws:

Exception

decode

protected abstract Object decode(ChannelHandlerContext ctx,
            ByteBuf in)
                          throws Exception

Throws:

Exception

decodeLast

protected Object decodeLast(ChannelHandlerContext ctx,
                ByteBuf in)
                     throws Exception

Throws:

Exception