io.netty.channel

Class ChannelInboundByteHandlerAdapter

java.lang.Object

io.netty.channel.ChannelStateHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelInboundByteHandlerAdapter

All Implemented Interfaces:

ChannelHandler, ChannelInboundByteHandler, ChannelInboundHandler, ChannelStateHandler

public abstract class ChannelInboundByteHandlerAdapter
extends ChannelInboundHandlerAdapter
implements ChannelInboundByteHandler

Abstract base class for ChannelInboundHandlerAdapter which should be extended by the user to get notified once more data is ready to get consumed from the inbound ByteBuf. This implementation is a good starting point for must users.

Nested Class Summary

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

ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
ChannelInboundByteHandlerAdapter()

Method Summary

Methods

Modifier and Type	Method and Description
void	inboundBufferUpdated(ChannelHandlerContext ctx) Does nothing by default.
abstract void	inboundBufferUpdated(ChannelHandlerContext ctx, io.netty.buffer.ByteBuf in) Callback which will get notifed once the given ByteBuf received more data to read.
io.netty.buffer.ByteBuf	newInboundBuffer(ChannelHandlerContext ctx) Create a new unpooled ByteBuf by default.

Methods inherited from class io.netty.channel.ChannelStateHandlerAdapter

afterAdd, afterRemove, beforeAdd, beforeRemove, channelActive, channelInactive, channelRegistered, channelUnregistered, exceptionCaught, userEventTriggered

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, channelRegistered, channelUnregistered

Methods inherited from interface io.netty.channel.ChannelHandler

afterAdd, afterRemove, beforeAdd, beforeRemove, exceptionCaught, userEventTriggered

Constructor Detail

ChannelInboundByteHandlerAdapter

public ChannelInboundByteHandlerAdapter()

Method Detail

newInboundBuffer

public io.netty.buffer.ByteBuf newInboundBuffer(ChannelHandlerContext ctx)
                                         throws Exception

Create a new unpooled ByteBuf by default. Sub-classes may override this to offer a more optimized implementation.

Specified by:

newInboundBuffer in interface ChannelInboundByteHandler

Specified by:

newInboundBuffer in interface ChannelInboundHandler

Throws:

Exception

inboundBufferUpdated

public final void inboundBufferUpdated(ChannelHandlerContext ctx)
                                throws Exception

Description copied from class: ChannelInboundHandlerAdapter

Does nothing by default. Sub-classes may override this if needed.

Specified by:

inboundBufferUpdated in interface ChannelStateHandler

Specified by:

inboundBufferUpdated in class ChannelInboundHandlerAdapter

Throws:

Exception

inboundBufferUpdated

public abstract void inboundBufferUpdated(ChannelHandlerContext ctx,
                        io.netty.buffer.ByteBuf in)
                                   throws Exception

Callback which will get notifed once the given ByteBuf received more data to read. What will be done with the data at this point is up to the implementation. Implementations may choose to read it or just let it in the buffer to read it later.

Throws:

Exception