Uses of Interface
io.netty.channel.ChannelHandler

Packages that use ChannelHandler

Package	Description
io.netty.bootstrap	The helper classes with fluent API which enable an easy implementation of typical client side and server side channel initialization.
io.netty.channel	The core channel API which is asynchronous and event-driven abstraction of various transports such as a NIO Channel.
io.netty.channel.embedded	A virtual Channel that helps wrapping a series of handlers to unit test the handlers or use them in non-I/O context.
io.netty.handler.address	Package to dynamically replace local / remote SocketAddress.
io.netty.handler.codec	Extensible decoder and its common implementations which deal with the packet fragmentation and reassembly issue found in a stream-based transport such as TCP/IP.
io.netty.handler.codec.base64	Encoder and decoder which transform a Base64-encoded String or ByteBuf into a decoded ByteBuf and vice versa.
io.netty.handler.codec.bytes	Encoder and decoder which transform an array of bytes into a ByteBuf and vice versa.
io.netty.handler.codec.compression	Encoder and decoder which compresses and decompresses ByteBufs in a compression format such as zlib, gzip, and Snappy.
io.netty.handler.codec.dns	DNS codec.
io.netty.handler.codec.haproxy	Decodes an HAProxy proxy protocol header
io.netty.handler.codec.http	Encoder, decoder and their related message types for HTTP.
io.netty.handler.codec.http.cors	This package contains Cross Origin Resource Sharing (CORS) related classes.
io.netty.handler.codec.http.websocketx	Encoder, decoder, handshakers and their related message types for Web Socket data frames.
io.netty.handler.codec.http.websocketx.extensions	Encoder, decoder, handshakers to handle WebSocket Extensions.
io.netty.handler.codec.http.websocketx.extensions.compression	Encoder, decoder, handshakers to handle most common WebSocket Compression Extensions.
io.netty.handler.codec.http2	Handlers for sending and receiving HTTP/2 frames.
io.netty.handler.codec.json	JSON specific codecs.
io.netty.handler.codec.marshalling	Decoder and Encoder which uses JBoss Marshalling.
io.netty.handler.codec.memcache	Common superset of ascii and binary classes.
io.netty.handler.codec.memcache.binary	Implementations and Interfaces for the Memcache Binary protocol.
io.netty.handler.codec.mqtt	Encoder, decoder and different Message Types for MQTT.
io.netty.handler.codec.protobuf	Encoder and decoder which transform a Google Protocol Buffers Message and MessageNano into a ByteBuf and vice versa.
io.netty.handler.codec.redis	Encoder, decoder for Redis.
io.netty.handler.codec.rtsp	An RTSP extension based on the HTTP codec.
io.netty.handler.codec.sctp	Decoder and encoders to manage message completion and multi-streaming codec in SCTP/IP.
io.netty.handler.codec.serialization	Encoder, decoder and their compatibility stream implementations which transform a Serializable object into a byte buffer and vice versa.
io.netty.handler.codec.smtp	SMTP codec.
io.netty.handler.codec.socks	Encoder, decoder and their related message types for Socks.
io.netty.handler.codec.socksx	Encoder, decoder and their related message types for SOCKS protocol.
io.netty.handler.codec.socksx.v4	Encoder, decoder and their related message types for SOCKSv4 protocol.
io.netty.handler.codec.socksx.v5	Encoder, decoder and their related message types for SOCKSv5 protocol.
io.netty.handler.codec.spdy	Encoder, decoder, session handler and their related message types for the SPDY protocol.
io.netty.handler.codec.stomp	STOMP codec
io.netty.handler.codec.string	Encoder and decoder which transform a String into a ByteBuf and vice versa.
io.netty.handler.codec.xml	XML codec provides asynchronous and non-blocking XML parser based on the Aalto XML parser.
io.netty.handler.flow	Package to control the flow of messages.
io.netty.handler.flush	Package to control flush behavior.
io.netty.handler.ipfilter	Package to filter IP addresses (allow/deny).
io.netty.handler.logging	Logs the I/O events for debugging purpose.
io.netty.handler.pcap	Capture data and write into Pcap format which helps in troubleshooting.
io.netty.handler.proxy	Adds support for client connections via proxy protocols such as SOCKS and HTTP CONNECT tunneling
io.netty.handler.ssl	SSL · TLS implementation based on SSLEngine
io.netty.handler.ssl.ocsp	Certificate validation using OCSP
io.netty.handler.stream	Writes very large data stream asynchronously neither spending a lot of memory nor getting OutOfMemoryError.
io.netty.handler.timeout	Adds support for read and write timeout and idle connection notification using a Timer.
io.netty.handler.traffic	Implementation of a Traffic Shaping Handler and Dynamic Statistics.

Uses of ChannelHandler in io.netty.bootstrap

Methods in io.netty.bootstrap that return ChannelHandler

Modifier and Type	Method and Description
ChannelHandler	ServerBootstrapConfig.childHandler() Returns the configured ChannelHandler be used for the child channels or null if non is configured yet.
ChannelHandler	AbstractBootstrapConfig.handler() Returns the configured ChannelHandler or null if non is configured yet.

Methods in io.netty.bootstrap with parameters of type ChannelHandler

Modifier and Type	Method and Description
ServerBootstrap	ServerBootstrap.childHandler(ChannelHandler childHandler) Set the ChannelHandler which is used to serve the request for the Channel's.
B	AbstractBootstrap.handler(ChannelHandler handler) the ChannelHandler to use for serving the requests.

Uses of ChannelHandler in io.netty.channel

Subinterfaces of ChannelHandler in io.netty.channel

Modifier and Type	Interface and Description
interface	ChannelInboundHandler ChannelHandler which adds callbacks for state changes.
interface	ChannelOutboundHandler ChannelHandler which will get notified for IO-outbound-operations.

Classes in io.netty.channel that implement ChannelHandler

Modifier and Type	Class and Description
class	ChannelDuplexHandler ChannelHandler implementation which represents a combination out of a ChannelInboundHandler and the ChannelOutboundHandler.
class	ChannelHandlerAdapter Skeleton implementation of a ChannelHandler.
class	ChannelInboundHandlerAdapter Abstract base class for ChannelInboundHandler implementations which provide implementations of all of their methods.
class	ChannelInitializer<C extends Channel> A special ChannelInboundHandler which offers an easy way to initialize a Channel once it was registered to its EventLoop.
class	ChannelOutboundHandlerAdapter Skeleton implementation of a ChannelOutboundHandler.
class	CombinedChannelDuplexHandler<I extends ChannelInboundHandler,O extends ChannelOutboundHandler> Combines a ChannelInboundHandler and a ChannelOutboundHandler into one ChannelHandler.
class	SimpleChannelInboundHandler<I> ChannelInboundHandlerAdapter which allows to explicit only handle a specific type of messages.
class	SimpleUserEventChannelHandler<I> ChannelInboundHandlerAdapter which allows to conveniently only handle a specific type of user events.

Methods in io.netty.channel with type parameters of type ChannelHandler

Modifier and Type	Method and Description
<T extends ChannelHandler> T	ChannelPipeline.get(Class<T> handlerType) Returns the ChannelHandler of the specified type in this pipeline.
<T extends ChannelHandler> T	DefaultChannelPipeline.get(Class<T> handlerType)
<T extends ChannelHandler> T	ChannelPipeline.remove(Class<T> handlerType) Removes the ChannelHandler of the specified type from this pipeline.
<T extends ChannelHandler> T	DefaultChannelPipeline.remove(Class<T> handlerType)
<T extends ChannelHandler> T	DefaultChannelPipeline.removeIfExists(ChannelHandler handler)
<T extends ChannelHandler> T	DefaultChannelPipeline.removeIfExists(Class<T> handlerType)
<T extends ChannelHandler> T	DefaultChannelPipeline.removeIfExists(String name)
<T extends ChannelHandler> T	ChannelPipeline.replace(Class<T> oldHandlerType, String newName, ChannelHandler newHandler) Replaces the ChannelHandler of the specified type with a new handler in this pipeline.
<T extends ChannelHandler> T	DefaultChannelPipeline.replace(Class<T> oldHandlerType, String newName, ChannelHandler newHandler)

Methods in io.netty.channel that return ChannelHandler

Modifier and Type	Method and Description
ChannelHandler	ChannelPipeline.first() Returns the first ChannelHandler in this pipeline.
ChannelHandler	DefaultChannelPipeline.first()
ChannelHandler	ChannelPipeline.get(String name) Returns the ChannelHandler with the specified name in this pipeline.
ChannelHandler	DefaultChannelPipeline.get(String name)
ChannelHandler	ChannelHandlerContext.handler() The ChannelHandler that is bound this ChannelHandlerContext.
ChannelHandler	ChannelPipeline.last() Returns the last ChannelHandler in this pipeline.
ChannelHandler	DefaultChannelPipeline.last()
ChannelHandler	ChannelPipeline.remove(String name) Removes the ChannelHandler with the specified name from this pipeline.
ChannelHandler	DefaultChannelPipeline.remove(String name)
ChannelHandler	ChannelPipeline.removeFirst() Removes the first ChannelHandler in this pipeline.
ChannelHandler	DefaultChannelPipeline.removeFirst()
ChannelHandler	ChannelPipeline.removeLast() Removes the last ChannelHandler in this pipeline.
ChannelHandler	DefaultChannelPipeline.removeLast()
ChannelHandler	ChannelPipeline.replace(String oldName, String newName, ChannelHandler newHandler) Replaces the ChannelHandler of the specified name with a new handler in this pipeline.
ChannelHandler	DefaultChannelPipeline.replace(String oldName, String newName, ChannelHandler newHandler)

Methods in io.netty.channel that return types with arguments of type ChannelHandler

Modifier and Type	Method and Description
Iterator<Map.Entry<String,ChannelHandler>>	DefaultChannelPipeline.iterator()
Map<String,ChannelHandler>	ChannelPipeline.toMap() Converts this pipeline into an ordered Map whose keys are handler names and whose values are handlers.
Map<String,ChannelHandler>	DefaultChannelPipeline.toMap()

Methods in io.netty.channel with parameters of type ChannelHandler

Modifier and Type	Method and Description
ChannelPipeline	ChannelPipeline.addAfter(EventExecutorGroup group, String baseName, String name, ChannelHandler handler) Inserts a ChannelHandler after an existing handler of this pipeline.
ChannelPipeline	DefaultChannelPipeline.addAfter(EventExecutorGroup group, String baseName, String name, ChannelHandler handler)
ChannelPipeline	ChannelPipeline.addAfter(String baseName, String name, ChannelHandler handler) Inserts a ChannelHandler after an existing handler of this pipeline.
ChannelPipeline	DefaultChannelPipeline.addAfter(String baseName, String name, ChannelHandler handler)
ChannelPipeline	ChannelPipeline.addBefore(EventExecutorGroup group, String baseName, String name, ChannelHandler handler) Inserts a ChannelHandler before an existing handler of this pipeline.
ChannelPipeline	DefaultChannelPipeline.addBefore(EventExecutorGroup group, String baseName, String name, ChannelHandler handler)
ChannelPipeline	ChannelPipeline.addBefore(String baseName, String name, ChannelHandler handler) Inserts a ChannelHandler before an existing handler of this pipeline.
ChannelPipeline	DefaultChannelPipeline.addBefore(String baseName, String name, ChannelHandler handler)
ChannelPipeline	ChannelPipeline.addFirst(ChannelHandler... handlers) Inserts ChannelHandlers at the first position of this pipeline.
ChannelPipeline	DefaultChannelPipeline.addFirst(ChannelHandler... handlers)
ChannelPipeline	DefaultChannelPipeline.addFirst(ChannelHandler handler)
ChannelPipeline	ChannelPipeline.addFirst(EventExecutorGroup group, ChannelHandler... handlers) Inserts ChannelHandlers at the first position of this pipeline.
ChannelPipeline	DefaultChannelPipeline.addFirst(EventExecutorGroup executor, ChannelHandler... handlers)
ChannelPipeline	ChannelPipeline.addFirst(EventExecutorGroup group, String name, ChannelHandler handler) Inserts a ChannelHandler at the first position of this pipeline.
ChannelPipeline	DefaultChannelPipeline.addFirst(EventExecutorGroup group, String name, ChannelHandler handler)
ChannelPipeline	ChannelPipeline.addFirst(String name, ChannelHandler handler) Inserts a ChannelHandler at the first position of this pipeline.
ChannelPipeline	DefaultChannelPipeline.addFirst(String name, ChannelHandler handler)
ChannelPipeline	ChannelPipeline.addLast(ChannelHandler... handlers) Inserts ChannelHandlers at the last position of this pipeline.
ChannelPipeline	DefaultChannelPipeline.addLast(ChannelHandler... handlers)
ChannelPipeline	DefaultChannelPipeline.addLast(ChannelHandler handler)
ChannelPipeline	ChannelPipeline.addLast(EventExecutorGroup group, ChannelHandler... handlers) Inserts ChannelHandlers at the last position of this pipeline.
ChannelPipeline	DefaultChannelPipeline.addLast(EventExecutorGroup executor, ChannelHandler... handlers)
ChannelPipeline	ChannelPipeline.addLast(EventExecutorGroup group, String name, ChannelHandler handler) Appends a ChannelHandler at the last position of this pipeline.
ChannelPipeline	DefaultChannelPipeline.addLast(EventExecutorGroup group, String name, ChannelHandler handler)
ChannelPipeline	ChannelPipeline.addLast(String name, ChannelHandler handler) Appends a ChannelHandler at the last position of this pipeline.
ChannelPipeline	DefaultChannelPipeline.addLast(String name, ChannelHandler handler)
ChannelHandlerContext	ChannelPipeline.context(ChannelHandler handler) Returns the context object of the specified ChannelHandler in this pipeline.
ChannelHandlerContext	DefaultChannelPipeline.context(ChannelHandler handler)
ChannelPipeline	ChannelPipeline.remove(ChannelHandler handler) Removes the specified ChannelHandler from this pipeline.
ChannelPipeline	DefaultChannelPipeline.remove(ChannelHandler handler)
<T extends ChannelHandler> T	DefaultChannelPipeline.removeIfExists(ChannelHandler handler)
ChannelPipeline	ChannelPipeline.replace(ChannelHandler oldHandler, String newName, ChannelHandler newHandler) Replaces the specified ChannelHandler with a new handler in this pipeline.
ChannelPipeline	DefaultChannelPipeline.replace(ChannelHandler oldHandler, String newName, ChannelHandler newHandler)
<T extends ChannelHandler> T	ChannelPipeline.replace(Class<T> oldHandlerType, String newName, ChannelHandler newHandler) Replaces the ChannelHandler of the specified type with a new handler in this pipeline.
<T extends ChannelHandler> T	DefaultChannelPipeline.replace(Class<T> oldHandlerType, String newName, ChannelHandler newHandler)
ChannelHandler	ChannelPipeline.replace(String oldName, String newName, ChannelHandler newHandler) Replaces the ChannelHandler of the specified name with a new handler in this pipeline.
ChannelHandler	DefaultChannelPipeline.replace(String oldName, String newName, ChannelHandler newHandler)

Method parameters in io.netty.channel with type arguments of type ChannelHandler

Modifier and Type	Method and Description
ChannelHandlerContext	ChannelPipeline.context(Class<? extends ChannelHandler> handlerType) Returns the context object of the ChannelHandler of the specified type in this pipeline.
ChannelHandlerContext	DefaultChannelPipeline.context(Class<? extends ChannelHandler> handlerType)

Uses of ChannelHandler in io.netty.channel.embedded

Constructors in io.netty.channel.embedded with parameters of type ChannelHandler

Constructor and Description
EmbeddedChannel(boolean register, boolean hasDisconnect, ChannelHandler... handlers) Create a new instance with the pipeline initialized with the specified handlers.
EmbeddedChannel(boolean hasDisconnect, ChannelHandler... handlers) Create a new instance with the pipeline initialized with the specified handlers.
EmbeddedChannel(Channel parent, ChannelId channelId, boolean register, boolean hasDisconnect, ChannelHandler... handlers) Create a new instance with the channel ID set to the given ID and the pipeline initialized with the specified handlers.
EmbeddedChannel(ChannelHandler... handlers) Create a new instance with the pipeline initialized with the specified handlers.
EmbeddedChannel(ChannelId channelId, boolean register, boolean hasDisconnect, ChannelHandler... handlers) Create a new instance with the channel ID set to the given ID and the pipeline initialized with the specified handlers.
EmbeddedChannel(ChannelId channelId, boolean hasDisconnect, ChannelConfig config, ChannelHandler... handlers) Create a new instance with the channel ID set to the given ID and the pipeline initialized with the specified handlers.
EmbeddedChannel(ChannelId channelId, boolean hasDisconnect, ChannelHandler... handlers) Create a new instance with the channel ID set to the given ID and the pipeline initialized with the specified handlers.
EmbeddedChannel(ChannelId channelId, ChannelHandler... handlers) Create a new instance with the channel ID set to the given ID and the pipeline initialized with the specified handlers.

Uses of ChannelHandler in io.netty.handler.address

Classes in io.netty.handler.address that implement ChannelHandler

Modifier and Type	Class and Description
class	DynamicAddressConnectHandler ChannelOutboundHandler implementation which allows to dynamically replace the used remoteAddress and / or localAddress when making a connection attempt.
class	ResolveAddressHandler ChannelOutboundHandlerAdapter which will resolve the SocketAddress that is passed to ResolveAddressHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) if it is not already resolved and the AddressResolver supports the type of SocketAddress.

Uses of ChannelHandler in io.netty.handler.codec

Classes in io.netty.handler.codec that implement ChannelHandler

Modifier and Type	Class and Description
class	ByteToMessageCodec<I> A Codec for on-the-fly encoding/decoding of bytes to messages and vise-versa.
class	ByteToMessageDecoder ChannelInboundHandlerAdapter which decodes bytes in a stream-like fashion from one ByteBuf to an other Message type.
class	DatagramPacketDecoder A decoder that decodes the content of the received DatagramPacket using the specified ByteBuf decoder.
class	DatagramPacketEncoder<M> An encoder that encodes the content in AddressedEnvelope to DatagramPacket using the specified message encoder.
class	DelimiterBasedFrameDecoder A decoder that splits the received ByteBufs by one or more delimiters.
class	FixedLengthFrameDecoder A decoder that splits the received ByteBufs by the fixed number of bytes.
class	LengthFieldBasedFrameDecoder A decoder that splits the received ByteBufs dynamically by the value of the length field in the message.
class	LengthFieldPrepender An encoder that prepends the length of the message.
class	LineBasedFrameDecoder A decoder that splits the received ByteBufs on line endings.
class	MessageAggregator<I,S,C extends ByteBufHolder,O extends ByteBufHolder> An abstract ChannelHandler that aggregates a series of message objects into a single aggregated message.
class	MessageToByteEncoder<I> ChannelOutboundHandlerAdapter which encodes message in a stream-like fashion from one message to an ByteBuf.
class	MessageToMessageCodec<INBOUND_IN,OUTBOUND_IN> A Codec for on-the-fly encoding/decoding of message.
class	MessageToMessageDecoder<I> ChannelInboundHandlerAdapter which decodes from one message to an other message.
class	MessageToMessageEncoder<I> ChannelOutboundHandlerAdapter which encodes from one message to an other message For example here is an implementation which decodes an Integer to an String.
class	ReplayingDecoder<S> A specialized variation of ByteToMessageDecoder which enables implementation of a non-blocking decoder in the blocking I/O paradigm.

Uses of ChannelHandler in io.netty.handler.codec.base64

Classes in io.netty.handler.codec.base64 that implement ChannelHandler

Modifier and Type	Class and Description
class	Base64Decoder Decodes a Base64-encoded ByteBuf or US-ASCII String into a ByteBuf.
class	Base64Encoder Encodes a ByteBuf into a Base64-encoded ByteBuf.

Uses of ChannelHandler in io.netty.handler.codec.bytes

Classes in io.netty.handler.codec.bytes that implement ChannelHandler

Modifier and Type	Class and Description
class	ByteArrayDecoder Decodes a received ByteBuf into an array of bytes.
class	ByteArrayEncoder Encodes the requested array of bytes into a ByteBuf.

Uses of ChannelHandler in io.netty.handler.codec.compression

Classes in io.netty.handler.codec.compression that implement ChannelHandler

Modifier and Type	Class and Description
class	BrotliDecoder Decompresses a ByteBuf encoded with the brotli format.
class	BrotliEncoder Compress a ByteBuf with the Brotli compression.
class	Bzip2Decoder Uncompresses a ByteBuf encoded with the Bzip2 format.
class	Bzip2Encoder Compresses a ByteBuf using the Bzip2 algorithm.
class	FastLzFrameDecoder Uncompresses a ByteBuf encoded by FastLzFrameEncoder using the FastLZ algorithm.
class	FastLzFrameEncoder Compresses a ByteBuf using the FastLZ algorithm.
class	JdkZlibDecoder Decompress a ByteBuf using the inflate algorithm.
class	JdkZlibEncoder Compresses a ByteBuf using the deflate algorithm.
class	JZlibDecoder
class	JZlibEncoder Compresses a ByteBuf using the deflate algorithm.
class	Lz4FrameDecoder Uncompresses a ByteBuf encoded with the LZ4 format.
class	Lz4FrameEncoder Compresses a ByteBuf using the LZ4 format.
class	LzfDecoder Uncompresses a ByteBuf encoded with the LZF format.
class	LzfEncoder Compresses a ByteBuf using the LZF format.
class	LzmaFrameEncoder Compresses a ByteBuf using the LZMA algorithm.
class	SnappyFramedDecoder Deprecated. Use SnappyFrameDecoder instead.
class	SnappyFrameDecoder Uncompresses a ByteBuf encoded with the Snappy framing format.
class	SnappyFramedEncoder Deprecated. Use SnappyFrameEncoder instead.
class	SnappyFrameEncoder Compresses a ByteBuf using the Snappy framing format.
class	ZlibDecoder Decompresses a ByteBuf using the deflate algorithm.
class	ZlibEncoder Compresses a ByteBuf using the deflate algorithm.
class	ZstdDecoder Decompresses a compressed block ByteBuf using the Zstandard algorithm.
class	ZstdEncoder Compresses a ByteBuf using the Zstandard algorithm.

Uses of ChannelHandler in io.netty.handler.codec.dns

Classes in io.netty.handler.codec.dns that implement ChannelHandler

Modifier and Type	Class and Description
class	DatagramDnsQueryDecoder Decodes a DatagramPacket into a DatagramDnsQuery.
class	DatagramDnsQueryEncoder Encodes a DatagramDnsQuery (or an AddressedEnvelope of DnsQuery} into a DatagramPacket.
class	DatagramDnsResponseDecoder Decodes a DatagramPacket into a DatagramDnsResponse.
class	DatagramDnsResponseEncoder Encodes a DatagramDnsResponse (or an AddressedEnvelope of DnsResponse} into a DatagramPacket.
class	TcpDnsQueryDecoder
class	TcpDnsQueryEncoder
class	TcpDnsResponseDecoder
class	TcpDnsResponseEncoder

Uses of ChannelHandler in io.netty.handler.codec.haproxy

Classes in io.netty.handler.codec.haproxy that implement ChannelHandler

Modifier and Type	Class and Description
class	HAProxyMessageDecoder Decodes an HAProxy proxy protocol header
class	HAProxyMessageEncoder Encodes an HAProxy proxy protocol message

Uses of ChannelHandler in io.netty.handler.codec.http

Classes in io.netty.handler.codec.http that implement ChannelHandler

Modifier and Type	Class and Description
class	HttpClientCodec A combination of HttpRequestEncoder and HttpResponseDecoder which enables easier client side HTTP implementation.
class	HttpClientUpgradeHandler Client-side handler for handling an HTTP upgrade handshake to another protocol.
class	HttpContentCompressor Compresses an HttpMessage and an HttpContent in gzip or deflate encoding while respecting the "Accept-Encoding" header.
class	HttpContentDecoder Decodes the content of the received HttpRequest and HttpContent.
class	HttpContentDecompressor Decompresses an HttpMessage and an HttpContent compressed in gzip or deflate encoding.
class	HttpContentEncoder Encodes the content of the outbound HttpResponse and HttpContent.
class	HttpObjectAggregator A ChannelHandler that aggregates an HttpMessage and its following HttpContents into a single FullHttpRequest or FullHttpResponse (depending on if it used to handle requests or responses) with no following HttpContents.
class	HttpObjectDecoder Decodes ByteBufs into HttpMessages and HttpContents.
class	HttpObjectEncoder<H extends HttpMessage> Encodes an HttpMessage or an HttpContent into a ByteBuf.
class	HttpRequestDecoder Decodes ByteBufs into HttpRequests and HttpContents.
class	HttpRequestEncoder Encodes an HttpRequest or an HttpContent into a ByteBuf.
class	HttpResponseDecoder Decodes ByteBufs into HttpResponses and HttpContents.
class	HttpResponseEncoder Encodes an HttpResponse or an HttpContent into a ByteBuf.
class	HttpServerCodec A combination of HttpRequestDecoder and HttpResponseEncoder which enables easier server side HTTP implementation.
class	HttpServerExpectContinueHandler Sends a 100 CONTINUE HttpResponse to HttpRequests which contain a 'expect: 100-continue' header.
class	HttpServerKeepAliveHandler HttpServerKeepAliveHandler helps close persistent connections when appropriate.
class	HttpServerUpgradeHandler A server-side handler that receives HTTP requests and optionally performs a protocol switch if the requested protocol is supported.

Uses of ChannelHandler in io.netty.handler.codec.http.cors

Classes in io.netty.handler.codec.http.cors that implement ChannelHandler

Modifier and Type	Class and Description
class	CorsHandler Handles Cross Origin Resource Sharing (CORS) requests.

Uses of ChannelHandler in io.netty.handler.codec.http.websocketx

Subinterfaces of ChannelHandler in io.netty.handler.codec.http.websocketx

Modifier and Type	Interface and Description
interface	WebSocketFrameDecoder Marker interface which all WebSocketFrame decoders need to implement.
interface	WebSocketFrameEncoder Marker interface which all WebSocketFrame encoders need to implement.

Classes in io.netty.handler.codec.http.websocketx that implement ChannelHandler

Modifier and Type	Class and Description
class	Utf8FrameValidator
class	WebSocket00FrameDecoder Decodes ByteBufs into WebSocketFrames.
class	WebSocket00FrameEncoder Encodes a WebSocketFrame into a ByteBuf.
class	WebSocket07FrameDecoder Decodes a web socket frame from wire protocol version 7 format.
class	WebSocket07FrameEncoder Encodes a web socket frame into wire protocol version 7 format.
class	WebSocket08FrameDecoder Decodes a web socket frame from wire protocol version 8 format.
class	WebSocket08FrameEncoder Encodes a web socket frame into wire protocol version 8 format.
class	WebSocket13FrameDecoder Decodes a web socket frame from wire protocol version 13 format.
class	WebSocket13FrameEncoder Encodes a web socket frame into wire protocol version 13 format.
class	WebSocketClientProtocolHandler This handler does all the heavy lifting for you to run a websocket client.
class	WebSocketFrameAggregator Handler that aggregate fragmented WebSocketFrame's.
class	WebSocketServerProtocolHandler This handler does all the heavy lifting for you to run a websocket server.

Uses of ChannelHandler in io.netty.handler.codec.http.websocketx.extensions

Classes in io.netty.handler.codec.http.websocketx.extensions that implement ChannelHandler

Modifier and Type	Class and Description
class	WebSocketClientExtensionHandler This handler negotiates and initializes the WebSocket Extensions.
class	WebSocketExtensionDecoder Convenient class for io.netty.handler.codec.http.websocketx.extensions.WebSocketExtension decoder.
class	WebSocketExtensionEncoder Convenient class for io.netty.handler.codec.http.websocketx.extensions.WebSocketExtension encoder.
class	WebSocketServerExtensionHandler This handler negotiates and initializes the WebSocket Extensions.

Uses of ChannelHandler in io.netty.handler.codec.http.websocketx.extensions.compression

Classes in io.netty.handler.codec.http.websocketx.extensions.compression that implement ChannelHandler

Modifier and Type	Class and Description
class	WebSocketClientCompressionHandler Extends io.netty.handler.codec.http.websocketx.extensions.compression.WebSocketClientExtensionHandler to handle the most common WebSocket Compression Extensions.
class	WebSocketServerCompressionHandler Extends io.netty.handler.codec.http.websocketx.extensions.compression.WebSocketServerExtensionHandler to handle the most common WebSocket Compression Extensions.

Uses of ChannelHandler in io.netty.handler.codec.http2

Classes in io.netty.handler.codec.http2 that implement ChannelHandler

Modifier and Type	Class and Description
class	CleartextHttp2ServerUpgradeHandler Performing cleartext upgrade, by h2c HTTP upgrade or Prior Knowledge.
class	Http2ChannelDuplexHandler A ChannelDuplexHandler providing additional functionality for HTTP/2.
class	Http2ConnectionHandler Provides the default implementation for processing inbound frame events and delegates to a Http2FrameListener This class will read HTTP/2 frames and delegate the events to a Http2FrameListener This interface enforces inbound flow control functionality through Http2LocalFlowController
class	Http2FrameCodec This API is very immature.
class	Http2FrameLogger Logs HTTP2 frames for debugging purposes.
class	Http2MultiplexCodec Deprecated. use Http2FrameCodecBuilder together with Http2MultiplexHandler.
class	Http2MultiplexHandler An HTTP/2 handler that creates child channels for each stream.
class	Http2StreamFrameToHttpObjectCodec This handler converts from Http2StreamFrame to HttpObject, and back.
class	HttpToHttp2ConnectionHandler Translates HTTP/1.x object writes into HTTP/2 frames.
class	InboundHttpToHttp2Adapter Translates HTTP/1.x object reads into HTTP/2 frames.

Methods in io.netty.handler.codec.http2 with parameters of type ChannelHandler

Modifier and Type	Method and Description
static Http2MultiplexCodecBuilder	Http2MultiplexCodecBuilder.forClient(ChannelHandler childHandler) Deprecated. Creates a builder for an HTTP/2 client.
static Http2MultiplexCodecBuilder	Http2MultiplexCodecBuilder.forServer(ChannelHandler childHandler) Deprecated. Creates a builder for an HTTP/2 server.
Http2StreamChannelBootstrap	Http2StreamChannelBootstrap.handler(ChannelHandler handler) the ChannelHandler to use for serving the requests.
Http2MultiplexCodecBuilder	Http2MultiplexCodecBuilder.withUpgradeStreamHandler(ChannelHandler upgradeStreamHandler) Deprecated.

Constructors in io.netty.handler.codec.http2 with parameters of type ChannelHandler

Constructor and Description
CleartextHttp2ServerUpgradeHandler(HttpServerCodec httpServerCodec, HttpServerUpgradeHandler httpServerUpgradeHandler, ChannelHandler http2ServerHandler) Creates the channel handler provide cleartext HTTP/2 upgrade from HTTP upgrade or prior knowledge
Http2ClientUpgradeCodec(Http2FrameCodec frameCodec, ChannelHandler upgradeToHandler)
Http2ClientUpgradeCodec(String handlerName, Http2FrameCodec frameCodec, ChannelHandler upgradeToHandler)
Http2MultiplexHandler(ChannelHandler inboundStreamHandler) Creates a new instance
Http2MultiplexHandler(ChannelHandler inboundStreamHandler, ChannelHandler upgradeStreamHandler) Creates a new instance
Http2ServerUpgradeCodec(Http2FrameCodec http2Codec, ChannelHandler... handlers) Creates the codec using a default name for the connection handler when adding to the pipeline.

Uses of ChannelHandler in io.netty.handler.codec.json

Classes in io.netty.handler.codec.json that implement ChannelHandler

Modifier and Type	Class and Description
class	JsonObjectDecoder Splits a byte stream of JSON objects and arrays into individual objects/arrays and passes them up the ChannelPipeline.

Uses of ChannelHandler in io.netty.handler.codec.marshalling

Classes in io.netty.handler.codec.marshalling that implement ChannelHandler

Modifier and Type	Class and Description
class	CompatibleMarshallingDecoder ReplayingDecoder which use an Unmarshaller to read the Object out of the ByteBuf.
class	CompatibleMarshallingEncoder MessageToByteEncoder implementation which uses JBoss Marshalling to marshal an Object.
class	MarshallingDecoder Decoder which MUST be used with MarshallingEncoder.
class	MarshallingEncoder MessageToByteEncoder implementation which uses JBoss Marshalling to marshal an Object.

Uses of ChannelHandler in io.netty.handler.codec.memcache

Classes in io.netty.handler.codec.memcache that implement ChannelHandler

Modifier and Type	Class and Description
class	AbstractMemcacheObjectAggregator<H extends MemcacheMessage> A ChannelHandler that aggregates an MemcacheMessage and its following MemcacheContents into a single MemcacheMessage with no following MemcacheContents.
class	AbstractMemcacheObjectDecoder Abstract super class for both ascii and binary decoders.
class	AbstractMemcacheObjectEncoder<M extends MemcacheMessage> A general purpose AbstractMemcacheObjectEncoder that encodes MemcacheMessages.

Uses of ChannelHandler in io.netty.handler.codec.memcache.binary

Classes in io.netty.handler.codec.memcache.binary that implement ChannelHandler

Modifier and Type	Class and Description
class	AbstractBinaryMemcacheDecoder<M extends BinaryMemcacheMessage> Decoder for both BinaryMemcacheRequest and BinaryMemcacheResponse.
class	AbstractBinaryMemcacheEncoder<M extends BinaryMemcacheMessage> A MessageToByteEncoder that encodes binary memcache messages into bytes.
class	BinaryMemcacheClientCodec The client codec that combines the proper encoder and decoder.
class	BinaryMemcacheObjectAggregator An object aggregator for the memcache binary protocol.
class	BinaryMemcacheRequestDecoder The decoder part which takes care of decoding the request-specific headers.
class	BinaryMemcacheRequestEncoder The encoder part which takes care of encoding the request headers.
class	BinaryMemcacheResponseDecoder The decoder which takes care of decoding the response headers.
class	BinaryMemcacheResponseEncoder The encoder which takes care of encoding the response headers.
class	BinaryMemcacheServerCodec The full server codec that combines the correct encoder and decoder.

Uses of ChannelHandler in io.netty.handler.codec.mqtt

Classes in io.netty.handler.codec.mqtt that implement ChannelHandler

Modifier and Type	Class and Description
class	MqttDecoder Decodes Mqtt messages from bytes, following the MQTT protocol specification v3.1 or v5.0, depending on the version specified in the CONNECT message that first goes through the channel.
class	MqttEncoder Encodes Mqtt messages into bytes following the protocol specification v3.1 as described here MQTTV3.1 or v5.0 as described here MQTTv5.0 - depending on the version specified in the first CONNECT message that goes through the channel.

Uses of ChannelHandler in io.netty.handler.codec.protobuf

Classes in io.netty.handler.codec.protobuf that implement ChannelHandler

Modifier and Type	Class and Description
class	ProtobufDecoder Decodes a received ByteBuf into a Google Protocol Buffers Message and MessageLite.
class	ProtobufDecoderNano Decodes a received ByteBuf into a Google Protocol Buffers MessageNano.
class	ProtobufEncoder Encodes the requested Google Protocol Buffers Message and MessageLite into a ByteBuf.
class	ProtobufEncoderNano Encodes the requested Google Protocol Buffers MessageNano into a ByteBuf.
class	ProtobufVarint32FrameDecoder A decoder that splits the received ByteBufs dynamically by the value of the Google Protocol Buffers Base 128 Varints integer length field in the message.
class	ProtobufVarint32LengthFieldPrepender An encoder that prepends the Google Protocol Buffers Uses of ChannelHandler in io.netty.handler.codec.redis Classes in io.netty.handler.codec.redis that implement ChannelHandler Modifier and Type Class and Description class RedisArrayAggregator Aggregates RedisMessage parts into ArrayRedisMessage. class RedisBulkStringAggregator A ChannelHandler that aggregates an BulkStringHeaderRedisMessage and its following BulkStringRedisContents into a single FullBulkStringRedisMessage with no following BulkStringRedisContents. class RedisDecoder Decodes the Redis protocol into RedisMessage objects following RESP (REdis Serialization Protocol). class RedisEncoder Encodes RedisMessage into bytes following RESP (REdis Serialization Protocol). Uses of ChannelHandler in io.netty.handler.codec.rtsp Classes in io.netty.handler.codec.rtsp that implement ChannelHandler Modifier and Type Class and Description class RtspDecoder Decodes ByteBufs into RTSP messages represented in HttpMessages. class RtspEncoder Encodes an RTSP message represented in HttpMessage or an HttpContent into a ByteBuf. class RtspObjectDecoder Deprecated. Use RtspDecoder instead. class RtspObjectEncoder<H extends HttpMessage> Deprecated. Use RtspEncoder instead. class RtspRequestDecoder Deprecated. Use RtspDecoder directly instead class RtspRequestEncoder Deprecated. Use RtspEncoder directly instead class RtspResponseDecoder Deprecated. Use RtspDecoder directly instead class RtspResponseEncoder Deprecated. Use RtspEncoder directly instead Uses of ChannelHandler in io.netty.handler.codec.sctp Classes in io.netty.handler.codec.sctp that implement ChannelHandler Modifier and Type Class and Description class SctpInboundByteStreamHandler A ChannelHandler which receives SctpMessages which belong to a application protocol form a specific SCTP Stream and decode it as ByteBuf. class SctpMessageCompletionHandler MessageToMessageDecoder which will take care of handle fragmented SctpMessages, so only complete SctpMessages will be forwarded to the next ChannelInboundHandler. class SctpMessageToMessageDecoder class SctpOutboundByteStreamHandler A ChannelHandler which transform ByteBuf to SctpMessage and send it through a specific stream with given protocol identifier. Uses of ChannelHandler in io.netty.handler.codec.serialization Classes in io.netty.handler.codec.serialization that implement ChannelHandler Modifier and Type Class and Description class CompatibleObjectEncoder Deprecated. This class has been deprecated with no replacement, because serialization can be a security liability class ObjectDecoder Deprecated. This class has been deprecated with no replacement, because serialization can be a security liability class ObjectEncoder Deprecated. This class has been deprecated with no replacement, because serialization can be a security liability Uses of ChannelHandler in io.netty.handler.codec.smtp Classes in io.netty.handler.codec.smtp that implement ChannelHandler Modifier and Type Class and Description class SmtpRequestEncoder Encoder for SMTP requests. class SmtpResponseDecoder Decoder for SMTP responses. Uses of ChannelHandler in io.netty.handler.codec.socks Classes in io.netty.handler.codec.socks that implement ChannelHandler Modifier and Type Class and Description class SocksAuthRequestDecoder Decodes ByteBufs into SocksAuthRequest. class SocksAuthResponseDecoder Decodes ByteBufs into SocksAuthResponse. class SocksCmdRequestDecoder Decodes ByteBufs into SocksCmdRequest. class SocksCmdResponseDecoder Decodes ByteBufs into SocksCmdResponse. class SocksInitRequestDecoder Decodes ByteBufs into SocksInitRequest. class SocksInitResponseDecoder Decodes ByteBufs into SocksInitResponse. class SocksMessageEncoder Encodes an SocksMessage into a ByteBuf. Uses of ChannelHandler in io.netty.handler.codec.socksx Classes in io.netty.handler.codec.socksx that implement ChannelHandler Modifier and Type Class and Description class SocksPortUnificationServerHandler Detects the version of the current SOCKS connection and initializes the pipeline with Socks4ServerDecoder or Socks5InitialRequestDecoder. Uses of ChannelHandler in io.netty.handler.codec.socksx.v4 Classes in io.netty.handler.codec.socksx.v4 that implement ChannelHandler Modifier and Type Class and Description class Socks4ClientDecoder Decodes a single Socks4CommandResponse from the inbound ByteBufs. class Socks4ClientEncoder Encodes a Socks4CommandRequest into a ByteBuf. class Socks4ServerDecoder Decodes a single Socks4CommandRequest from the inbound ByteBufs. class Socks4ServerEncoder Encodes a Socks4CommandResponse into a ByteBuf. Uses of ChannelHandler in io.netty.handler.codec.socksx.v5 Classes in io.netty.handler.codec.socksx.v5 that implement ChannelHandler Modifier and Type Class and Description class Socks5ClientEncoder Encodes a client-side Socks5Message into a ByteBuf. class Socks5CommandRequestDecoder Decodes a single Socks5CommandRequest from the inbound ByteBufs. class Socks5CommandResponseDecoder Decodes a single Socks5CommandResponse from the inbound ByteBufs. class Socks5InitialRequestDecoder Decodes a single Socks5InitialRequest from the inbound ByteBufs. class Socks5InitialResponseDecoder Decodes a single Socks5InitialResponse from the inbound ByteBufs. class Socks5PasswordAuthRequestDecoder Decodes a single Socks5PasswordAuthRequest from the inbound ByteBufs. class Socks5PasswordAuthResponseDecoder Decodes a single Socks5PasswordAuthResponse from the inbound ByteBufs. class Socks5ServerEncoder Encodes a server-side Socks5Message into a ByteBuf. Uses of ChannelHandler in io.netty.handler.codec.spdy Classes in io.netty.handler.codec.spdy that implement ChannelHandler Modifier and Type Class and Description class SpdyFrameCodec A ChannelHandler that encodes and decodes SPDY Frames. class SpdyHttpCodec A combination of SpdyHttpDecoder and SpdyHttpEncoder class SpdyHttpDecoder Decodes SpdySynStreamFrames, SpdySynReplyFrames, and SpdyDataFrames into FullHttpRequests and FullHttpResponses. class SpdyHttpEncoder Encodes HttpRequests, HttpResponses, and HttpContents into SpdySynStreamFrames and SpdySynReplyFrames. class SpdyHttpResponseStreamIdHandler MessageToMessageCodec that takes care of adding the right SpdyHttpHeaders.Names.STREAM_ID to the HttpMessage if one is not present. class SpdySessionHandler Manages streams within a SPDY session. Uses of ChannelHandler in io.netty.handler.codec.stomp Classes in io.netty.handler.codec.stomp that implement ChannelHandler Modifier and Type Class and Description class StompSubframeAggregator A ChannelHandler that aggregates an StompHeadersSubframe and its following StompContentSubframes into a single StompFrame. class StompSubframeDecoder Decodes ByteBufs into StompHeadersSubframes and StompContentSubframes. class StompSubframeEncoder Encodes a StompFrame or a StompSubframe into a ByteBuf. Uses of ChannelHandler in io.netty.handler.codec.string Classes in io.netty.handler.codec.string that implement ChannelHandler Modifier and Type Class and Description class LineEncoder Apply a line separator to the requested String and encode it into a ByteBuf. class StringDecoder Decodes a received ByteBuf into a String. class StringEncoder Encodes the requested String into a ByteBuf. Uses of ChannelHandler in io.netty.handler.codec.xml Classes in io.netty.handler.codec.xml that implement ChannelHandler Modifier and Type Class and Description class XmlDecoder Async XML decoder based on Aalto XML parser. class XmlFrameDecoder A frame decoder for single separate XML based message streams. Uses of ChannelHandler in io.netty.handler.flow Classes in io.netty.handler.flow that implement ChannelHandler Modifier and Type Class and Description class FlowControlHandler The FlowControlHandler ensures that only one message per read() is sent downstream. Uses of ChannelHandler in io.netty.handler.flush Classes in io.netty.handler.flush that implement ChannelHandler Modifier and Type Class and Description class FlushConsolidationHandler ChannelDuplexHandler which consolidates Channel.flush() / ChannelHandlerContext.flush() operations (which also includes ChannelOutboundInvoker.writeAndFlush(Object) / ChannelOutboundInvoker.writeAndFlush(Object, ChannelPromise) and ChannelOutboundInvoker.writeAndFlush(Object) / ChannelOutboundInvoker.writeAndFlush(Object, ChannelPromise)). Uses of ChannelHandler in io.netty.handler.ipfilter Classes in io.netty.handler.ipfilter that implement ChannelHandler Modifier and Type Class and Description class AbstractRemoteAddressFilter<T extends SocketAddress> This class provides the functionality to either accept or reject new Channels based on their IP address. class IpSubnetFilter This class allows one to filter new Channels based on the IpSubnetFilters passed to its constructor. class RuleBasedIpFilter This class allows one to filter new Channels based on the IpFilterRules passed to its constructor. class UniqueIpFilter This class allows one to ensure that at all times for every IP address there is at most one Channel connected to the server. Uses of ChannelHandler in io.netty.handler.logging Classes in io.netty.handler.logging that implement ChannelHandler Modifier and Type Class and Description class LoggingHandler A ChannelHandler that logs all events using a logging framework. Uses of ChannelHandler in io.netty.handler.pcap Classes in io.netty.handler.pcap that implement ChannelHandler Modifier and Type Class and Description class PcapWriteHandler PcapWriteHandler captures ByteBuf from SocketChannel / ServerChannel or DatagramPacket and writes it into Pcap OutputStream. Uses of ChannelHandler in io.netty.handler.proxy Classes in io.netty.handler.proxy that implement ChannelHandler Modifier and Type Class and Description class HttpProxyHandler Handler that establishes a blind forwarding proxy tunnel using HTTP/1.1 CONNECT request. class ProxyHandler A common abstraction for protocols that establish blind forwarding proxy tunnels. class Socks4ProxyHandler Handler that establishes a blind forwarding proxy tunnel using SOCKS4 protocol. class Socks5ProxyHandler Handler that establishes a blind forwarding proxy tunnel using SOCKS Protocol Version 5. Uses of ChannelHandler in io.netty.handler.ssl Classes in io.netty.handler.ssl that implement ChannelHandler Modifier and Type Class and Description class AbstractSniHandler<T> Enables SNI (Server Name Indication) extension for server side SSL. class ApplicationProtocolNegotiationHandler Configures a ChannelPipeline depending on the application-level protocol negotiation result of SslHandler. class OptionalSslHandler OptionalSslHandler is a utility decoder to support both SSL and non-SSL handlers based on the first message received. class SniHandler Enables SNI (Server Name Indication) extension for server side SSL. class SslClientHelloHandler<T> ByteToMessageDecoder which allows to be notified once a full ClientHello was received. class SslHandler Adds SSL · TLS and StartTLS support to a Channel. class SslMasterKeyHandler The SslMasterKeyHandler is a channel-handler you can include in your pipeline to consume the master key & session identifier for a TLS session. Methods in io.netty.handler.ssl that return ChannelHandler Modifier and Type Method and Description protected ChannelHandler OptionalSslHandler.newNonSslHandler(ChannelHandlerContext context) Override to configure the ChannelHandler. Uses of ChannelHandler in io.netty.handler.ssl.ocsp Classes in io.netty.handler.ssl.ocsp that implement ChannelHandler Modifier and Type Class and Description class OcspClientHandler A handler for SSL clients to handle and act upon stapled OCSP responses. class OcspServerCertificateValidator OcspServerCertificateValidator validates incoming server's certificate using OCSP. Uses of ChannelHandler in io.netty.handler.stream Classes in io.netty.handler.stream that implement ChannelHandler Modifier and Type Class and Description class ChunkedWriteHandler A ChannelHandler that adds support for writing a large data stream asynchronously neither spending a lot of memory nor getting OutOfMemoryError. Uses of ChannelHandler in io.netty.handler.timeout Classes in io.netty.handler.timeout that implement ChannelHandler Modifier and Type Class and Description class IdleStateHandler Triggers an IdleStateEvent when a Channel has not performed read, write, or both operation for a while. class ReadTimeoutHandler Raises a ReadTimeoutException when no data was read within a certain period of time. class WriteTimeoutHandler Raises a WriteTimeoutException when a write operation cannot finish in a certain period of time. Uses of ChannelHandler in io.netty.handler.traffic Classes in io.netty.handler.traffic that implement ChannelHandler Modifier and Type Class and Description class AbstractTrafficShapingHandler AbstractTrafficShapingHandler allows to limit the global bandwidth (see GlobalTrafficShapingHandler) or per session bandwidth (see ChannelTrafficShapingHandler), as traffic shaping. class ChannelTrafficShapingHandler This implementation of the AbstractTrafficShapingHandler is for channel traffic shaping, that is to say a per channel limitation of the bandwidth. class GlobalChannelTrafficShapingHandler This implementation of the AbstractTrafficShapingHandler is for global and per channel traffic shaping, that is to say a global limitation of the bandwidth, whatever the number of opened channels and a per channel limitation of the bandwidth. class GlobalTrafficShapingHandler This implementation of the AbstractTrafficShapingHandler is for global traffic shaping, that is to say a global limitation of the bandwidth, whatever the number of opened channels. Skip navigation links Overview Package Class Use Tree Deprecated Index Help Prev Next Frames No Frames All Classes Copyright © 2008–2024 The Netty Project. All rights reserved.