io.netty.channel

Interface ChannelInboundHandler

All Superinterfaces:

ChannelHandler

All Known Subinterfaces:

WebSocketFrameDecoder

All Known Implementing Classes:

AbstractBinaryMemcacheDecoder, AbstractMemcacheObjectAggregator, AbstractMemcacheObjectDecoder, AbstractRemoteAddressFilter, AbstractSniHandler, AbstractTrafficShapingHandler, ApplicationProtocolNegotiationHandler, Base64Decoder, BinaryMemcacheClientCodec, BinaryMemcacheObjectAggregator, BinaryMemcacheRequestDecoder, BinaryMemcacheResponseDecoder, BinaryMemcacheServerCodec, BrotliDecoder, ByteArrayDecoder, ByteToMessageCodec, ByteToMessageDecoder, Bzip2Decoder, ChannelDuplexHandler, ChannelInboundHandlerAdapter, ChannelInitializer, ChannelTrafficShapingHandler, ChunkedWriteHandler, CleartextHttp2ServerUpgradeHandler, CombinedChannelDuplexHandler, CompatibleMarshallingDecoder, CorsHandler, DatagramDnsQueryDecoder, DatagramDnsResponseDecoder, DatagramPacketDecoder, DelimiterBasedFrameDecoder, FastLzFrameDecoder, FixedLengthFrameDecoder, FlowControlHandler, FlushConsolidationHandler, GlobalChannelTrafficShapingHandler, GlobalTrafficShapingHandler, HAProxyMessageDecoder, Http2ChannelDuplexHandler, Http2ConnectionHandler, Http2FrameCodec, Http2MultiplexCodec, Http2MultiplexHandler, Http2StreamFrameToHttpObjectCodec, HttpClientCodec, HttpClientUpgradeHandler, HttpContentCompressor, HttpContentDecoder, HttpContentDecompressor, HttpContentEncoder, HttpObjectAggregator, HttpObjectDecoder, HttpProxyHandler, HttpRequestDecoder, HttpResponseDecoder, HttpServerCodec, HttpServerExpectContinueHandler, HttpServerKeepAliveHandler, HttpServerUpgradeHandler, HttpToHttp2ConnectionHandler, IdleStateHandler, InboundHttpToHttp2Adapter, IpSubnetFilter, JdkZlibDecoder, JsonObjectDecoder, JZlibDecoder, LengthFieldBasedFrameDecoder, LineBasedFrameDecoder, LoggingHandler, Lz4FrameDecoder, LzfDecoder, MarshallingDecoder, MessageAggregator, MessageToMessageCodec, MessageToMessageDecoder, MqttDecoder, ObjectDecoder, OcspClientHandler, OcspServerCertificateValidator, OptionalSslHandler, PcapWriteHandler, ProtobufDecoder, ProtobufDecoderNano, ProtobufVarint32FrameDecoder, ProxyHandler, ReadTimeoutHandler, RedisArrayAggregator, RedisBulkStringAggregator, RedisDecoder, ReplayingDecoder, RtspDecoder, RtspObjectDecoder, RtspRequestDecoder, RtspResponseDecoder, RuleBasedIpFilter, SctpInboundByteStreamHandler, SctpMessageCompletionHandler, SctpMessageToMessageDecoder, SimpleChannelInboundHandler, SimpleUserEventChannelHandler, SmtpResponseDecoder, SnappyFramedDecoder, SnappyFrameDecoder, SniHandler, Socks4ClientDecoder, Socks4ProxyHandler, Socks4ServerDecoder, Socks5CommandRequestDecoder, Socks5CommandResponseDecoder, Socks5InitialRequestDecoder, Socks5InitialResponseDecoder, Socks5PasswordAuthRequestDecoder, Socks5PasswordAuthResponseDecoder, Socks5ProxyHandler, SocksAuthRequestDecoder, SocksAuthResponseDecoder, SocksCmdRequestDecoder, SocksCmdResponseDecoder, SocksInitRequestDecoder, SocksInitResponseDecoder, SocksPortUnificationServerHandler, SpdyFrameCodec, SpdyHttpCodec, SpdyHttpDecoder, SpdyHttpResponseStreamIdHandler, SpdySessionHandler, SslClientHelloHandler, SslHandler, SslMasterKeyHandler, StompSubframeAggregator, StompSubframeDecoder, StringDecoder, TcpDnsQueryDecoder, TcpDnsResponseDecoder, UniqueIpFilter, Utf8FrameValidator, WebSocket00FrameDecoder, WebSocket07FrameDecoder, WebSocket08FrameDecoder, WebSocket13FrameDecoder, WebSocketClientCompressionHandler, WebSocketClientExtensionHandler, WebSocketClientProtocolHandler, WebSocketExtensionDecoder, WebSocketFrameAggregator, WebSocketServerCompressionHandler, WebSocketServerExtensionHandler, WebSocketServerProtocolHandler, XmlDecoder, XmlFrameDecoder, ZlibDecoder, ZstdDecoder

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

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	channelRead(ChannelHandlerContext ctx, Object msg) Invoked when the current Channel has read a message from the peer.
void	channelReadComplete(ChannelHandlerContext ctx) Invoked when the last message read by the current read operation has been consumed by channelRead(ChannelHandlerContext, Object).
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	exceptionCaught(ChannelHandlerContext ctx, Throwable cause) Gets called if a Throwable was thrown.
void	userEventTriggered(ChannelHandlerContext ctx, Object evt) Gets called if an user event was triggered.

Methods inherited from interface io.netty.channel.ChannelHandler

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

channelRead

void channelRead(ChannelHandlerContext ctx,
                 Object msg)
          throws Exception

Invoked when the current Channel has read a message from the peer.

Throws:

Exception

channelReadComplete

void channelReadComplete(ChannelHandlerContext ctx)
                  throws Exception

Invoked when the last message read by the current read operation has been consumed by channelRead(ChannelHandlerContext, Object). If ChannelOption.AUTO_READ is off, no further attempt to read an inbound data from the current Channel will be made until ChannelHandlerContext.read() is called.

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

exceptionCaught

void exceptionCaught(ChannelHandlerContext ctx,
                     Throwable cause)
              throws Exception

Gets called if a Throwable was thrown.

Specified by:

exceptionCaught in interface ChannelHandler

Throws:

Exception