io.netty.channel

Class ChannelInboundMessageHandlerAdapter<I>

java.lang.Object

io.netty.channel.ChannelStateHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelInboundMessageHandlerAdapter<I>

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler, ChannelInboundMessageHandler<I>, ChannelStateHandler

public abstract class ChannelInboundMessageHandlerAdapter<I>
extends ChannelInboundHandlerAdapter
implements ChannelInboundMessageHandler<I>

Nested Class Summary

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

ChannelHandler.Sharable

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ChannelInboundMessageHandlerAdapter(Class<?>... acceptedMsgTypes)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	beginMessageReceived(ChannelHandlerContext ctx) Will get notified once inboundBufferUpdated(ChannelHandlerContext) was called.
void	endMessageReceived(ChannelHandlerContext ctx)
void	inboundBufferUpdated(ChannelHandlerContext ctx) Does nothing by default.
boolean	isSupported(Object msg) Returns true if and only if the specified message can be handled by this handler.
abstract void	messageReceived(ChannelHandlerContext ctx, I msg)
io.netty.buffer.MessageBuf<I>	newInboundBuffer(ChannelHandlerContext ctx) Return the MessageBuf which will be used for inbound data to store.

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

ChannelInboundMessageHandlerAdapter

protected ChannelInboundMessageHandlerAdapter(Class<?>... acceptedMsgTypes)

Method Detail

newInboundBuffer

public io.netty.buffer.MessageBuf<I> newInboundBuffer(ChannelHandlerContext ctx)
                                               throws Exception

Description copied from interface: ChannelInboundMessageHandler

Return the MessageBuf which will be used for inbound data to store.

Specified by:

newInboundBuffer in interface ChannelInboundHandler

Specified by:

newInboundBuffer in interface ChannelInboundMessageHandler<I>

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

isSupported

public boolean isSupported(Object msg)
                    throws Exception

Returns true if and only if the specified message can be handled by this handler.

Parameters:

msg - the message

Throws:

Exception

beginMessageReceived

public boolean beginMessageReceived(ChannelHandlerContext ctx)
                             throws Exception

Will get notified once inboundBufferUpdated(ChannelHandlerContext) was called. If this method returns false no further processing of the MessageBuf will be done until the next call of inboundBufferUpdated(ChannelHandlerContext). This will return true by default, and may get overriden by sub-classes for special handling.

Throws:

Exception

messageReceived

public abstract void messageReceived(ChannelHandlerContext ctx,
                   I msg)
                              throws Exception

Throws:

Exception

endMessageReceived

public void endMessageReceived(ChannelHandlerContext ctx)
                        throws Exception

Throws:

Exception