io.netty.channel

Class ChannelInboundHandlerAdapter

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler

Direct Known Subclasses:

ChannelDuplexHandler, ChannelInitializer, SimpleChannelInboundHandler

public class ChannelInboundHandlerAdapter
extends ChannelHandlerAdapter
implements ChannelInboundHandler

Abstract base class for ChannelInboundHandler implementations which provide implementations of all of their methods.

This implementation just forward the operation to the next ChannelHandler in the ChannelPipeline. Sub-classes may override a method implementation to change this.

Be aware that messages are not released after the messageReceived(ChannelHandlerContext, MessageList) method returns automatically. This is done for make it as flexible as possible and get the most out of performance. Because of this you need to explicit call MessageList.releaseAllAndRecycle() if you consumed all the messages. Because this is such a common need SimpleChannelInboundHandler is provided , which will automatically release messages and the MessageList after processing is done.

Nested Class Summary

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

ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
ChannelInboundHandlerAdapter()

Method Summary

Methods

Modifier and Type	Method and Description
void	channelActive(ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelActive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelInactive(ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelReadSuspended(ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelReadSuspended() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelRegistered(ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelRegistered() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelUnregistered(ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelUnregistered() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelWritabilityChanged(ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelWritabilityChanged() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	messageReceived(ChannelHandlerContext ctx, MessageList<Object> msgs) Calls ChannelHandlerContext.fireMessageReceived(MessageList) to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	userEventTriggered(ChannelHandlerContext ctx, Object evt) Calls ChannelHandlerContext.fireUserEventTriggered(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

exceptionCaught, handlerAdded, handlerRemoved

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

ChannelInboundHandlerAdapter

public ChannelInboundHandlerAdapter()

Method Detail

channelRegistered

public void channelRegistered(ChannelHandlerContext ctx)
                       throws Exception

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

Specified by:

channelRegistered in interface ChannelInboundHandler

Throws:

Exception

channelUnregistered

public void channelUnregistered(ChannelHandlerContext ctx)
                         throws Exception

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

Specified by:

channelUnregistered in interface ChannelInboundHandler

Throws:

Exception

channelActive

public void channelActive(ChannelHandlerContext ctx)
                   throws Exception

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

Specified by:

channelActive in interface ChannelInboundHandler

Throws:

Exception

channelInactive

public void channelInactive(ChannelHandlerContext ctx)
                     throws Exception

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

Specified by:

channelInactive in interface ChannelInboundHandler

Throws:

Exception

channelReadSuspended

public void channelReadSuspended(ChannelHandlerContext ctx)
                          throws Exception

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

Specified by:

channelReadSuspended in interface ChannelInboundHandler

Throws:

Exception

messageReceived

public void messageReceived(ChannelHandlerContext ctx,
                   MessageList<Object> msgs)
                     throws Exception

Calls ChannelHandlerContext.fireMessageReceived(MessageList) to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

messageReceived in interface ChannelInboundHandler

Throws:

Exception

userEventTriggered

public void userEventTriggered(ChannelHandlerContext ctx,
                      Object evt)
                        throws Exception

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

Specified by:

userEventTriggered in interface ChannelInboundHandler

Throws:

Exception

channelWritabilityChanged

public void channelWritabilityChanged(ChannelHandlerContext ctx)
                               throws Exception

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

Specified by:

channelWritabilityChanged in interface ChannelInboundHandler

Throws:

Exception