io.netty.channel

Interface ChannelInboundHandler

All Superinterfaces:

ChannelHandler

All Known Implementing Classes:

ChannelDuplexHandler, ChannelInboundHandlerAdapter, ChannelInitializer, CombinedChannelDuplexHandler, SimpleChannelInboundHandler

public interface ChannelInboundHandler
extends ChannelHandler

ChannelHandler which adds callbacks for state changes. This allows the user to hook in to state changes easily.

Nested Class Summary

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

ChannelHandler.Sharable

Method Summary

Methods

Modifier and Type	Method and Description
void	channelActive(ChannelHandlerContext ctx) The Channel of the ChannelHandlerContext is now active
void	channelInactive(ChannelHandlerContext ctx) The Channel of the ChannelHandlerContext was registered is now inactive and reached its end of lifetime.
void	channelReadSuspended(ChannelHandlerContext ctx) Invoked when a ChannelOutboundInvoker.read() is finished and the inbound buffer of this handler will not be updated until another ChannelOutboundInvoker.read() request is issued.
void	channelRegistered(ChannelHandlerContext ctx) The Channel of the ChannelHandlerContext was registered with its EventLoop
void	channelUnregistered(ChannelHandlerContext ctx) The Channel of the ChannelHandlerContext was unregistered from its EventLoop
void	channelWritabilityChanged(ChannelHandlerContext ctx) Gets called once the writable state of a Channel changed.
void	messageReceived(ChannelHandlerContext ctx, MessageList<Object> msgs) The inbound buffer of the ChannelHandlerContext was updated with new data.
void	userEventTriggered(ChannelHandlerContext ctx, Object evt) Gets called if an user event was triggered.

Methods inherited from interface io.netty.channel.ChannelHandler

exceptionCaught, handlerAdded, handlerRemoved

Method Detail

channelRegistered

void channelRegistered(ChannelHandlerContext ctx)
                       throws Exception

The Channel of the ChannelHandlerContext was registered with its EventLoop

Throws:

Exception

channelUnregistered

void channelUnregistered(ChannelHandlerContext ctx)
                         throws Exception

The Channel of the ChannelHandlerContext was unregistered from its EventLoop

Throws:

Exception

channelActive

void channelActive(ChannelHandlerContext ctx)
                   throws Exception

The Channel of the ChannelHandlerContext is now active

Throws:

Exception

channelInactive

void channelInactive(ChannelHandlerContext ctx)
                     throws Exception

The Channel of the ChannelHandlerContext was registered is now inactive and reached its end of lifetime.

Throws:

Exception

channelReadSuspended

void channelReadSuspended(ChannelHandlerContext ctx)
                          throws Exception

Invoked when a ChannelOutboundInvoker.read() is finished and the inbound buffer of this handler will not be updated until another ChannelOutboundInvoker.read() request is issued.

Throws:

Exception

messageReceived

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

The inbound buffer of the ChannelHandlerContext was updated with new data. This means something may be ready to get processed by the actual ChannelInboundHandler 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.

Throws:

Exception

userEventTriggered

void userEventTriggered(ChannelHandlerContext ctx,
                      Object evt)
                        throws Exception

Gets called if an user event was triggered.

Throws:

Exception

channelWritabilityChanged

void channelWritabilityChanged(ChannelHandlerContext ctx)
                               throws Exception

Gets called once the writable state of a Channel changed. You can check the state with Channel.isWritable().

Throws:

Exception