Uses of Interface
io.netty.channel.ChannelHandler
Packages that use ChannelHandler
Package
Description
The helper classes with fluent API which enable an easy implementation of
typical client side and server side channel initialization.
The core channel API which is asynchronous and event-driven abstraction of
various transports such as a
NIO Channel.
A virtual
Channel that helps wrapping a series of handlers to
unit test the handlers or use them in non-I/O context.Package to dynamically replace local / remote
SocketAddress.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.
Encoder and decoder which transform an array of bytes into a
ByteBuf and vice versa.DNS codec.
Decodes an HAProxy proxy protocol header
Encoder, decoder and their related message types for HTTP.
This package contains Cross Origin Resource Sharing (CORS) related classes.
Encoder, decoder, handshakers and their related message types for
Web Socket data frames.
Encoder, decoder, handshakers to handle
WebSocket Extensions.
Encoder, decoder, handshakers to handle most common WebSocket Compression Extensions.
Handlers for sending and receiving HTTP/2 frames.
HTTP/3 implementation.
JSON specific codecs.
Decoder and Encoder which uses JBoss Marshalling.
Common superset of ascii and binary classes.
Implementations and Interfaces for the Memcache Binary protocol.
Encoder, decoder and different Message Types for MQTT.
Encoder and decoder which transform a
Google Protocol Buffers
Message and MessageNano into a
ByteBuf and vice versa.QUIC implementation
Encoder, decoder for Redis.
An RTSP
extension based on the HTTP codec.
Decoder and encoders to manage message completion and multi-streaming codec in SCTP/IP.
Encoder, decoder and their compatibility stream implementations which
transform a
Serializable object into a byte buffer and
vice versa.SMTP codec.
Encoder, decoder and their related message types for Socks.
Encoder, decoder and their related message types for SOCKS protocol.
Encoder, decoder and their related message types for SOCKSv4 protocol.
Encoder, decoder and their related message types for SOCKSv5 protocol.
Encoder, decoder, session handler and their related message types for the SPDY protocol.
STOMP codec
XML codec provides asynchronous and non-blocking XML parser based on the
Aalto XML parser.
Package to control the flow of messages.
Package to control flush behavior.
Package to filter IP addresses (allow/deny).
Logs the I/O events for debugging purpose.
Capture data and write into Pcap format which helps in troubleshooting.
Adds support for client connections via proxy protocols such as
SOCKS and
HTTP CONNECT tunneling
Certificate validation using OCSP
Writes very large data stream asynchronously neither spending a lot of
memory nor getting
OutOfMemoryError.Adds support for read and write timeout and idle connection notification
using a
Timer.Implementation of a Traffic Shaping Handler and Dynamic Statistics.
-
Uses of ChannelHandler in io.netty.bootstrap
Methods in io.netty.bootstrap that return ChannelHandlerModifier and TypeMethodDescriptionServerBootstrapConfig.childHandler()Returns the configuredChannelHandlerbe used for the child channels ornullif non is configured yet.final ChannelHandlerAbstractBootstrapConfig.handler()Returns the configuredChannelHandlerornullif non is configured yet.Methods in io.netty.bootstrap with parameters of type ChannelHandlerModifier and TypeMethodDescriptionServerBootstrap.childHandler(ChannelHandler childHandler) Set theChannelHandlerwhich is used to serve the request for theChannel's.AbstractBootstrap.handler(ChannelHandler handler) theChannelHandlerto use for serving the requests. -
Uses of ChannelHandler in io.netty.channel
Subinterfaces of ChannelHandler in io.netty.channelModifier and TypeInterfaceDescriptioninterfaceChannelHandlerwhich adds callbacks for state changes.interfaceChannelHandlerwhich will get notified for IO-outbound-operations.Classes in io.netty.channel that implement ChannelHandlerModifier and TypeClassDescriptionclassChannelHandlerimplementation which represents a combination out of aChannelInboundHandlerand theChannelOutboundHandler.classSkeleton implementation of aChannelHandler.classAbstract base class forChannelInboundHandlerimplementations which provide implementations of all of their methods.classChannelInitializer<C extends Channel>A specialChannelInboundHandlerwhich offers an easy way to initialize aChannelonce it was registered to itsEventLoop.classSkeleton implementation of aChannelOutboundHandler.classCombinedChannelDuplexHandler<I extends ChannelInboundHandler, O extends ChannelOutboundHandler>classChannelInboundHandlerAdapterwhich allows to explicit only handle a specific type of messages.classChannelInboundHandlerAdapterwhich allows to conveniently only handle a specific type of user events.Subinterfaces with type arguments of type ChannelHandler in io.netty.channelModifier and TypeInterfaceDescriptioninterfaceA list ofChannelHandlers which handles or intercepts inbound events and outbound operations of aChannel.Methods in io.netty.channel with type parameters of type ChannelHandlerModifier and TypeMethodDescription<T extends ChannelHandler>
TReturns theChannelHandlerof the specified type in this pipeline.final <T extends ChannelHandler>
T<T extends ChannelHandler>
TRemoves theChannelHandlerof the specified type from this pipeline.final <T extends ChannelHandler>
Tfinal <T extends ChannelHandler>
TDefaultChannelPipeline.removeIfExists(ChannelHandler handler) final <T extends ChannelHandler>
TDefaultChannelPipeline.removeIfExists(Class<T> handlerType) final <T extends ChannelHandler>
TDefaultChannelPipeline.removeIfExists(String name) <T extends ChannelHandler>
TChannelPipeline.replace(Class<T> oldHandlerType, String newName, ChannelHandler newHandler) Replaces theChannelHandlerof the specified type with a new handler in this pipeline.final <T extends ChannelHandler>
TDefaultChannelPipeline.replace(Class<T> oldHandlerType, String newName, ChannelHandler newHandler) Methods in io.netty.channel that return ChannelHandlerModifier and TypeMethodDescriptionChannelPipeline.first()Returns the firstChannelHandlerin this pipeline.final ChannelHandlerDefaultChannelPipeline.first()Returns theChannelHandlerwith the specified name in this pipeline.final ChannelHandlerChannelHandlerContext.handler()TheChannelHandlerthat is bound thisChannelHandlerContext.ChannelPipeline.last()Returns the lastChannelHandlerin this pipeline.final ChannelHandlerDefaultChannelPipeline.last()Removes theChannelHandlerwith the specified name from this pipeline.final ChannelHandlerChannelPipeline.removeFirst()Removes the firstChannelHandlerin this pipeline.final ChannelHandlerDefaultChannelPipeline.removeFirst()ChannelPipeline.removeLast()Removes the lastChannelHandlerin this pipeline.final ChannelHandlerDefaultChannelPipeline.removeLast()ChannelPipeline.replace(String oldName, String newName, ChannelHandler newHandler) Replaces theChannelHandlerof the specified name with a new handler in this pipeline.final ChannelHandlerDefaultChannelPipeline.replace(String oldName, String newName, ChannelHandler newHandler) Methods in io.netty.channel that return types with arguments of type ChannelHandlerModifier and TypeMethodDescriptionfinal Iterator<Map.Entry<String, ChannelHandler>> DefaultChannelPipeline.iterator()ChannelPipeline.toMap()Converts this pipeline into an orderedMapwhose keys are handler names and whose values are handlers.final Map<String, ChannelHandler> DefaultChannelPipeline.toMap()Methods in io.netty.channel with parameters of type ChannelHandlerModifier and TypeMethodDescriptionChannelPipeline.addAfter(EventExecutorGroup group, String baseName, String name, ChannelHandler handler) Deprecated.ChannelPipeline.addAfter(String baseName, String name, ChannelHandler handler) Inserts aChannelHandlerafter an existing handler of this pipeline.final ChannelPipelineDefaultChannelPipeline.addAfter(EventExecutorGroup group, String baseName, String name, ChannelHandler handler) final ChannelPipelineDefaultChannelPipeline.addAfter(String baseName, String name, ChannelHandler handler) ChannelPipeline.addBefore(EventExecutorGroup group, String baseName, String name, ChannelHandler handler) Deprecated.ChannelPipeline.addBefore(String baseName, String name, ChannelHandler handler) Inserts aChannelHandlerbefore an existing handler of this pipeline.final ChannelPipelineDefaultChannelPipeline.addBefore(EventExecutorGroup group, String baseName, String name, ChannelHandler handler) final ChannelPipelineDefaultChannelPipeline.addBefore(String baseName, String name, ChannelHandler handler) ChannelPipeline.addFirst(ChannelHandler... handlers) InsertsChannelHandlers at the first position of this pipeline.ChannelPipeline.addFirst(EventExecutorGroup group, ChannelHandler... handlers) Deprecated.ChannelPipeline.addFirst(EventExecutorGroup group, String name, ChannelHandler handler) Deprecated.ChannelPipeline.addFirst(String name, ChannelHandler handler) Inserts aChannelHandlerat the first position of this pipeline.final ChannelPipelineDefaultChannelPipeline.addFirst(ChannelHandler handler) final ChannelPipelineDefaultChannelPipeline.addFirst(ChannelHandler... handlers) final ChannelPipelineDefaultChannelPipeline.addFirst(EventExecutorGroup executor, ChannelHandler... handlers) final ChannelPipelineDefaultChannelPipeline.addFirst(EventExecutorGroup group, String name, ChannelHandler handler) final ChannelPipelineDefaultChannelPipeline.addFirst(String name, ChannelHandler handler) ChannelPipeline.addLast(ChannelHandler... handlers) InsertsChannelHandlers at the last position of this pipeline.ChannelPipeline.addLast(EventExecutorGroup group, ChannelHandler... handlers) Deprecated.ChannelPipeline.addLast(EventExecutorGroup group, String name, ChannelHandler handler) Deprecated.ChannelPipeline.addLast(String name, ChannelHandler handler) Appends aChannelHandlerat the last position of this pipeline.final ChannelPipelineDefaultChannelPipeline.addLast(ChannelHandler handler) final ChannelPipelineDefaultChannelPipeline.addLast(ChannelHandler... handlers) final ChannelPipelineDefaultChannelPipeline.addLast(EventExecutorGroup executor, ChannelHandler... handlers) final ChannelPipelineDefaultChannelPipeline.addLast(EventExecutorGroup group, String name, ChannelHandler handler) final ChannelPipelineDefaultChannelPipeline.addLast(String name, ChannelHandler handler) ChannelPipeline.context(ChannelHandler handler) Returns the context object of the specifiedChannelHandlerin this pipeline.final ChannelHandlerContextDefaultChannelPipeline.context(ChannelHandler handler) ChannelPipeline.remove(ChannelHandler handler) Removes the specifiedChannelHandlerfrom this pipeline.final ChannelPipelineDefaultChannelPipeline.remove(ChannelHandler handler) final <T extends ChannelHandler>
TDefaultChannelPipeline.removeIfExists(ChannelHandler handler) ChannelPipeline.replace(ChannelHandler oldHandler, String newName, ChannelHandler newHandler) Replaces the specifiedChannelHandlerwith a new handler in this pipeline.<T extends ChannelHandler>
TChannelPipeline.replace(Class<T> oldHandlerType, String newName, ChannelHandler newHandler) Replaces theChannelHandlerof the specified type with a new handler in this pipeline.ChannelPipeline.replace(String oldName, String newName, ChannelHandler newHandler) Replaces theChannelHandlerof the specified name with a new handler in this pipeline.final ChannelPipelineDefaultChannelPipeline.replace(ChannelHandler oldHandler, String newName, ChannelHandler newHandler) final <T extends ChannelHandler>
TDefaultChannelPipeline.replace(Class<T> oldHandlerType, String newName, ChannelHandler newHandler) final ChannelHandlerDefaultChannelPipeline.replace(String oldName, String newName, ChannelHandler newHandler) Method parameters in io.netty.channel with type arguments of type ChannelHandlerModifier and TypeMethodDescriptionChannelPipeline.context(Class<? extends ChannelHandler> handlerType) Returns the context object of theChannelHandlerof the specified type in this pipeline.final ChannelHandlerContextDefaultChannelPipeline.context(Class<? extends ChannelHandler> handlerType) -
Uses of ChannelHandler in io.netty.channel.embedded
Methods in io.netty.channel.embedded with parameters of type ChannelHandlerModifier and TypeMethodDescriptionEmbeddedChannel.Builder.handlers(ChannelHandler handler) TheChannelHandlerwhich will be added to theChannelPipeline.EmbeddedChannel.Builder.handlers(ChannelHandler... handlers) TheChannelHandlers which will be added to theChannelPipeline.Constructors in io.netty.channel.embedded with parameters of type ChannelHandlerModifierConstructorDescriptionEmbeddedChannel(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(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.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. -
Uses of ChannelHandler in io.netty.handler.address
Classes in io.netty.handler.address that implement ChannelHandlerModifier and TypeClassDescriptionclassChannelOutboundHandlerimplementation which allows to dynamically replace the usedremoteAddressand / orlocalAddresswhen making a connection attempt.classChannelOutboundHandlerAdapterwhich will resolve theSocketAddressthat is passed toResolveAddressHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise)if it is not already resolved and theAddressResolversupports the type ofSocketAddress. -
Uses of ChannelHandler in io.netty.handler.codec
Classes in io.netty.handler.codec that implement ChannelHandlerModifier and TypeClassDescriptionclassA Codec for on-the-fly encoding/decoding of bytes to messages and vise-versa.classChannelInboundHandlerAdapterwhich decodes bytes in a stream-like fashion from oneByteBufto another Message type.classA decoder that decodes the content of the receivedDatagramPacketusing the specifiedByteBufdecoder.classAn encoder that encodes the content inAddressedEnvelopetoDatagramPacketusing the specified message encoder.classA decoder that splits the receivedByteBufs by one or more delimiters.classA decoder that splits the receivedByteBufs by the fixed number of bytes.classA decoder that splits the receivedByteBufs dynamically by the value of the length field in the message.classAn encoder that prepends the length of the message.classA decoder that splits the receivedByteBufs on line endings.classMessageAggregator<I, S, C extends ByteBufHolder, O extends ByteBufHolder>An abstractChannelHandlerthat aggregates a series of message objects into a single aggregated message.classChannelOutboundHandlerAdapterwhich encodes message in a stream-like fashion from one message to anByteBuf.classMessageToMessageCodec<INBOUND_IN, OUTBOUND_IN>A Codec for on-the-fly encoding/decoding of message.classChannelInboundHandlerAdapterwhich decodes from one message to an other message.classChannelOutboundHandlerAdapterwhich encodes from one message to an other message For example here is an implementation which decodes anIntegerto anString.classA specialized variation ofByteToMessageDecoderwhich 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 ChannelHandlerModifier and TypeClassDescriptionclassclass -
Uses of ChannelHandler in io.netty.handler.codec.bytes
Classes in io.netty.handler.codec.bytes that implement ChannelHandler -
Uses of ChannelHandler in io.netty.handler.codec.compression
Classes in io.netty.handler.codec.compression that implement ChannelHandlerModifier and TypeClassDescriptionfinal classDecompresses aByteBufencoded with the brotli format.final classCompress aByteBufwith the Brotli compression.classUncompresses aByteBufencoded with the Bzip2 format.classCompresses aByteBufusing the Bzip2 algorithm.classUncompresses aByteBufencoded byFastLzFrameEncoderusing the FastLZ algorithm.classCompresses aByteBufusing the FastLZ algorithm.classDecompress aByteBufusing the inflate algorithm.classCompresses aByteBufusing the deflate algorithm.classclassCompresses aByteBufusing the deflate algorithm.classUncompresses aByteBufencoded with the LZ4 format.classCompresses aByteBufusing the LZ4 format.classUncompresses aByteBufencoded with the LZF format.classCompresses aByteBufusing the LZF format.classCompresses aByteBufusing the LZMA algorithm.classDeprecated.UseSnappyFrameDecoderinstead.classUncompresses aByteBufencoded with the Snappy framing format.classDeprecated.UseSnappyFrameEncoderinstead.classCompresses aByteBufusing the Snappy framing format.classDecompresses aByteBufusing the deflate algorithm.classCompresses aByteBufusing the deflate algorithm.final classDecompresses a compressed blockByteBufusing the Zstandard algorithm.final classCompresses aByteBufusing the Zstandard algorithm. -
Uses of ChannelHandler in io.netty.handler.codec.dns
Classes in io.netty.handler.codec.dns that implement ChannelHandlerModifier and TypeClassDescriptionclassDecodes aDatagramPacketinto aDatagramDnsQuery.classclassDecodes aDatagramPacketinto aDatagramDnsResponse.classfinal classfinal classfinal classfinal class -
Uses of ChannelHandler in io.netty.handler.codec.haproxy
Classes in io.netty.handler.codec.haproxy that implement ChannelHandlerModifier and TypeClassDescriptionclassDecodes an HAProxy proxy protocol headerfinal classEncodes an HAProxy proxy protocol message -
Uses of ChannelHandler in io.netty.handler.codec.http
Classes in io.netty.handler.codec.http that implement ChannelHandlerModifier and TypeClassDescriptionfinal classA combination ofHttpRequestEncoderandHttpResponseDecoderwhich enables easier client side HTTP implementation.classClient-side handler for handling an HTTP upgrade handshake to another protocol.classCompresses anHttpMessageand anHttpContentingzipordeflateencoding while respecting the"Accept-Encoding"header.classDecodes the content of the receivedHttpRequestandHttpContent.classclassEncodes the content of the outboundHttpResponseandHttpContent.classAChannelHandlerthat aggregates anHttpMessageand its followingHttpContents into a singleFullHttpRequestorFullHttpResponse(depending on if it used to handle requests or responses) with no followingHttpContents.classclassHttpObjectEncoder<H extends HttpMessage>classclassclassclassfinal classA combination ofHttpRequestDecoderandHttpResponseEncoderwhich enables easier server side HTTP implementation.classclassHttpServerKeepAliveHandler helps close persistent connections when appropriate.classA 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 -
Uses of ChannelHandler in io.netty.handler.codec.http.websocketx
Subinterfaces of ChannelHandler in io.netty.handler.codec.http.websocketxModifier and TypeInterfaceDescriptioninterfaceMarker interface which all WebSocketFrame decoders need to implement.interfaceMarker interface which all WebSocketFrame encoders need to implement.Classes in io.netty.handler.codec.http.websocketx that implement ChannelHandlerModifier and TypeClassDescriptionclassclassDecodesByteBufs intoWebSocketFrames.classEncodes aWebSocketFrameinto aByteBuf.classDecodes a web socket frame from wire protocol version 7 format.classEncodes a web socket frame into wire protocol version 7 format.classDecodes a web socket frame from wire protocol version 8 format.classEncodes a web socket frame into wire protocol version 8 format.classDecodes a web socket frame from wire protocol version 13 format.classEncodes a web socket frame into wire protocol version 13 format.classThis handler does all the heavy lifting for you to run a websocket client.classHandler that aggregate fragmented WebSocketFrame's.classThis 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 ChannelHandlerModifier and TypeClassDescriptionclassThis handler negotiates and initializes the WebSocket Extensions.classConvenient class for io.netty.handler.codec.http.websocketx.extensions.WebSocketExtension decoder.classConvenient class for io.netty.handler.codec.http.websocketx.extensions.WebSocketExtension encoder.classThis 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 ChannelHandlerModifier and TypeClassDescriptionfinal classExtends io.netty.handler.codec.http.websocketx.extensions.compression.WebSocketClientExtensionHandler to handle the most common WebSocket Compression Extensions.classExtends 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 ChannelHandlerModifier and TypeClassDescriptionfinal classPerforming cleartext upgrade, by h2c HTTP upgrade or Prior Knowledge.classAChannelDuplexHandlerproviding additional functionality for HTTP/2.classProvides the default implementation for processing inbound frame events and delegates to aHttp2FrameListenerclassAn HTTP/2 handler that maps HTTP/2 frames toHttp2Frameobjects and vice versa.classLogs HTTP2 frames for debugging purposes.classDeprecated.useHttp2FrameCodecBuildertogether withHttp2MultiplexHandler.final classAn HTTP/2 handler that creates child channels for each stream.classThis handler converts fromHttp2StreamFrametoHttpObject, and back.classTranslates HTTP/1.x object writes into HTTP/2 frames.classTranslates HTTP/1.x object reads into HTTP/2 frames.Methods in io.netty.handler.codec.http2 with parameters of type ChannelHandlerModifier and TypeMethodDescriptionstatic Http2MultiplexCodecBuilderHttp2MultiplexCodecBuilder.forClient(ChannelHandler childHandler) Deprecated.Creates a builder for an HTTP/2 client.static Http2MultiplexCodecBuilderHttp2MultiplexCodecBuilder.forServer(ChannelHandler childHandler) Deprecated.Creates a builder for an HTTP/2 server.Http2StreamChannelBootstrap.handler(ChannelHandler handler) theChannelHandlerto use for serving the requests.Http2MultiplexCodecBuilder.withUpgradeStreamHandler(ChannelHandler upgradeStreamHandler) Deprecated.Constructors in io.netty.handler.codec.http2 with parameters of type ChannelHandlerModifierConstructorDescriptionCleartextHttp2ServerUpgradeHandler(HttpServerCodec httpServerCodec, HttpServerUpgradeHandler httpServerUpgradeHandler, ChannelHandler http2ServerHandler) Creates the channel handler provide cleartext HTTP/2 upgrade from HTTP upgrade or prior knowledgeHttp2ClientUpgradeCodec(Http2FrameCodec frameCodec, ChannelHandler upgradeToHandler) Http2ClientUpgradeCodec(String handlerName, Http2FrameCodec frameCodec, ChannelHandler upgradeToHandler) Http2MultiplexHandler(ChannelHandler inboundStreamHandler) Creates a new instanceHttp2MultiplexHandler(ChannelHandler inboundStreamHandler, ChannelHandler upgradeStreamHandler) Creates a new instanceHttp2ServerUpgradeCodec(Http2FrameCodec http2Codec, ChannelHandler... handlers) Creates the codec using a default name for the connection handler when adding to the pipeline.Http2ServerUpgradeCodec(String handlerName, Http2ConnectionHandler connectionHandler, ChannelHandler... handlers) -
Uses of ChannelHandler in io.netty.handler.codec.http3
Classes in io.netty.handler.codec.http3 that implement ChannelHandlerModifier and TypeClassDescriptionfinal classclassHandler that handles HTTP3 connections.final classThis handler converts fromHttp3RequestStreamFrametoHttpObject, and back.classAbstract base class that users can extend to init HTTP/3 push-streams for clients.classAbstract base class that users can extend to init HTTP/3 push-streams for servers.classChannelInboundHandlerAdapterwhich makes it easy to handle HTTP3 request streams.classAbstract base class that users can extend to init HTTP/3 request-streams.final classHandler that handles HTTP3 for the server-side.Methods in io.netty.handler.codec.http3 with parameters of type ChannelHandlerModifier and TypeMethodDescriptionHttp3ServerPushStreamManager.newPushStream(long pushId, @Nullable ChannelHandler handler) Returns a new HTTP/3 push-stream that will use the givenChannelHandlerto dispatchHttp3PushStreamFrames too.voidHttp3ServerPushStreamManager.newPushStream(long pushId, @Nullable ChannelHandler handler, Promise<QuicStreamChannel> promise) Returns a new HTTP/3 push-stream that will use the givenChannelHandlerto dispatchHttp3PushStreamFrames too.voidHttp3ServerPushStreamManager.newPushStream(long pushId, @Nullable ChannelHandler handler, UnaryOperator<QuicStreamChannelBootstrap> bootstrapConfigurator, Promise<QuicStreamChannel> promise) Returns a new HTTP/3 push-stream that will use the givenChannelHandlerto dispatchHttp3PushStreamFrames too.static Future<QuicStreamChannel> Http3.newRequestStream(QuicChannel channel, ChannelHandler handler) Returns a new HTTP/3 request-stream that will use the givenChannelHandlerto dispatchHttp3RequestStreamFrames too.static QuicStreamChannelBootstrapHttp3.newRequestStreamBootstrap(QuicChannel channel, ChannelHandler handler) Returns a new HTTP/3 request-stream bootstrap that will use the givenChannelHandlerto dispatchHttp3RequestStreamFrames too.Constructors in io.netty.handler.codec.http3 with parameters of type ChannelHandlerModifierConstructorDescriptionHttp3ClientConnectionHandler(@Nullable ChannelHandler inboundControlStreamHandler, @Nullable LongFunction<ChannelHandler> pushStreamHandlerFactory, @Nullable LongFunction<ChannelHandler> unknownInboundStreamHandlerFactory, @Nullable Http3SettingsFrame localSettings, boolean disableQpackDynamicTable) Create a new instance.Http3ServerConnectionHandler(ChannelHandler requestStreamHandler) Create a new instance.Http3ServerConnectionHandler(ChannelHandler requestStreamHandler, @Nullable ChannelHandler inboundControlStreamHandler, @Nullable LongFunction<ChannelHandler> unknownInboundStreamHandlerFactory, @Nullable Http3SettingsFrame localSettings, boolean disableQpackDynamicTable) Create a new instance.Constructor parameters in io.netty.handler.codec.http3 with type arguments of type ChannelHandlerModifierConstructorDescriptionHttp3ClientConnectionHandler(@Nullable ChannelHandler inboundControlStreamHandler, @Nullable LongFunction<ChannelHandler> pushStreamHandlerFactory, @Nullable LongFunction<ChannelHandler> unknownInboundStreamHandlerFactory, @Nullable Http3SettingsFrame localSettings, boolean disableQpackDynamicTable) Create a new instance.Http3ServerConnectionHandler(ChannelHandler requestStreamHandler, @Nullable ChannelHandler inboundControlStreamHandler, @Nullable LongFunction<ChannelHandler> unknownInboundStreamHandlerFactory, @Nullable Http3SettingsFrame localSettings, boolean disableQpackDynamicTable) Create a new instance. -
Uses of ChannelHandler in io.netty.handler.codec.json
Classes in io.netty.handler.codec.json that implement ChannelHandlerModifier and TypeClassDescriptionclassSplits a byte stream of JSON objects and arrays into individual objects/arrays and passes them up theChannelPipeline. -
Uses of ChannelHandler in io.netty.handler.codec.marshalling
Classes in io.netty.handler.codec.marshalling that implement ChannelHandlerModifier and TypeClassDescriptionclassclassMessageToByteEncoderimplementation which uses JBoss Marshalling to marshal an Object.classDecoder which MUST be used withMarshallingEncoder.classMessageToByteEncoderimplementation 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 ChannelHandlerModifier and TypeClassDescriptionclassAbstractMemcacheObjectAggregator<H extends MemcacheMessage>AChannelHandlerthat aggregates anMemcacheMessageand its followingMemcacheContents into a singleMemcacheMessagewith no followingMemcacheContents.classAbstract super class for both ascii and binary decoders.classAbstractMemcacheObjectEncoder<M extends MemcacheMessage>A general purposeAbstractMemcacheObjectEncoderthat encodesMemcacheMessages. -
Uses of ChannelHandler in io.netty.handler.codec.memcache.binary
Classes in io.netty.handler.codec.memcache.binary that implement ChannelHandlerModifier and TypeClassDescriptionclassDecoder for bothBinaryMemcacheRequestandBinaryMemcacheResponse.classAMessageToByteEncoderthat encodes binary memcache messages into bytes.final classThe client codec that combines the proper encoder and decoder.classAn object aggregator for the memcache binary protocol.classThe decoder part which takes care of decoding the request-specific headers.classThe encoder part which takes care of encoding the request headers.classThe decoder which takes care of decoding the response headers.classThe encoder which takes care of encoding the response headers.classThe 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 ChannelHandlerModifier and TypeClassDescriptionfinal classfinal class -
Uses of ChannelHandler in io.netty.handler.codec.protobuf
Classes in io.netty.handler.codec.protobuf that implement ChannelHandlerModifier and TypeClassDescriptionclassclassclassclassclassA decoder that splits the receivedByteBufs dynamically by the value of the Google Protocol Buffers Base 128 Varints integer length field in the message.classAn encoder that prepends the Google Protocol Buffers Base 128 Varints integer length field. -
Uses of ChannelHandler in io.netty.handler.codec.quic
Classes in io.netty.handler.codec.quic that implement ChannelHandlerModifier and TypeClassDescriptionclassSpecialChannelHandlerthat should be used to initChannels that will be used for QUIC while SO_REUSEPORT is used to bind to sameInetSocketAddressmultiple times.Methods in io.netty.handler.codec.quic that return ChannelHandlerModifier and TypeMethodDescriptionfinal ChannelHandlerQuicCodecBuilder.build()Builds the QUIC codec that should be added to theChannelPipelineof the underlyingChannelwhich is used as transport for QUIC.Methods in io.netty.handler.codec.quic with parameters of type ChannelHandlerModifier and TypeMethodDescriptiondefault Future<QuicStreamChannel> QuicChannel.createStream(QuicStreamType type, @Nullable ChannelHandler handler) Creates a stream that is using thisQuicChanneland notifies theFutureonce done.QuicChannel.createStream(QuicStreamType type, @Nullable ChannelHandler handler, Promise<QuicStreamChannel> promise) Creates a stream that is using thisQuicChanneland notifies thePromiseonce done.QuicChannelBootstrap.handler(ChannelHandler handler) QuicServerCodecBuilder.handler(ChannelHandler handler) QuicStreamChannelBootstrap.handler(ChannelHandler streamHandler) QuicChannelBootstrap.streamHandler(ChannelHandler streamHandler) QuicServerCodecBuilder.streamHandler(ChannelHandler streamHandler) -
Uses of ChannelHandler in io.netty.handler.codec.redis
Classes in io.netty.handler.codec.redis that implement ChannelHandlerModifier and TypeClassDescriptionfinal classAggregatesRedisMessageparts intoArrayRedisMessage.final classAChannelHandlerthat aggregates anBulkStringHeaderRedisMessageand its followingBulkStringRedisContents into a singleFullBulkStringRedisMessagewith no followingBulkStringRedisContents.final classDecodes the Redis protocol intoRedisMessageobjects following RESP (REdis Serialization Protocol).classEncodesRedisMessageinto bytes following RESP (REdis Serialization Protocol). -
Uses of ChannelHandler in io.netty.handler.codec.rtsp
Classes in io.netty.handler.codec.rtsp that implement ChannelHandlerModifier and TypeClassDescriptionclassDecodesByteBufs into RTSP messages represented inHttpMessages.classclassDeprecated.UseRtspDecoderinstead.classRtspObjectEncoder<H extends HttpMessage>Deprecated.UseRtspEncoderinstead.classDeprecated.UseRtspDecoderdirectly insteadclassDeprecated.UseRtspEncoderdirectly insteadclassDeprecated.UseRtspDecoderdirectly insteadclassDeprecated.UseRtspEncoderdirectly instead -
Uses of ChannelHandler in io.netty.handler.codec.sctp
Classes in io.netty.handler.codec.sctp that implement ChannelHandlerModifier and TypeClassDescriptionclassA ChannelHandler which receivesSctpMessages which belong to a application protocol form a specific SCTP Stream and decode it asByteBuf.classMessageToMessageDecoderwhich will take care of handle fragmentedSctpMessages, so only completeSctpMessages will be forwarded to the nextChannelInboundHandler.classclassA ChannelHandler which transformByteBuftoSctpMessageand 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 ChannelHandlerModifier and TypeClassDescriptionclassDeprecated.This class has been deprecated with no replacement, because serialization can be a security liabilityclassDeprecated.This class has been deprecated with no replacement, because serialization can be a security liabilityclassDeprecated.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 ChannelHandlerModifier and TypeClassDescriptionfinal classEncoder for SMTP requests.final classDecoder for SMTP responses. -
Uses of ChannelHandler in io.netty.handler.codec.socks
Classes in io.netty.handler.codec.socks that implement ChannelHandlerModifier and TypeClassDescriptionclassDecodesByteBufs intoSocksAuthRequest.classDecodesByteBufs intoSocksAuthResponse.classDecodesByteBufs intoSocksCmdRequest.classDecodesByteBufs intoSocksCmdResponse.classDecodesByteBufs intoSocksInitRequest.classDecodesByteBufs intoSocksInitResponse.classEncodes anSocksMessageinto aByteBuf. -
Uses of ChannelHandler in io.netty.handler.codec.socksx
Classes in io.netty.handler.codec.socksx that implement ChannelHandlerModifier and TypeClassDescriptionclassDetects the version of the current SOCKS connection and initializes the pipeline withSocks4ServerDecoderorSocks5InitialRequestDecoder. -
Uses of ChannelHandler in io.netty.handler.codec.socksx.v4
Classes in io.netty.handler.codec.socksx.v4 that implement ChannelHandlerModifier and TypeClassDescriptionclassDecodes a singleSocks4CommandResponsefrom the inboundByteBufs.final classEncodes aSocks4CommandRequestinto aByteBuf.classDecodes a singleSocks4CommandRequestfrom the inboundByteBufs.final classEncodes aSocks4CommandResponseinto aByteBuf. -
Uses of ChannelHandler in io.netty.handler.codec.socksx.v5
Classes in io.netty.handler.codec.socksx.v5 that implement ChannelHandlerModifier and TypeClassDescriptionclassEncodes a client-sideSocks5Messageinto aByteBuf.classDecodes a singleSocks5CommandRequestfrom the inboundByteBufs.classDecodes a singleSocks5CommandResponsefrom the inboundByteBufs.classDecodes a singleSocks5InitialRequestfrom the inboundByteBufs.classDecodes a singleSocks5InitialResponsefrom the inboundByteBufs.classDecodes a singleSocks5PasswordAuthRequestfrom the inboundByteBufs.classDecodes a singleSocks5PasswordAuthResponsefrom the inboundByteBufs.final classDecodes a singleSocks5PrivateAuthRequestfrom the inboundByteBufs.final classDecodes a singleSocks5PrivateAuthResponsefrom the inboundByteBufs.classEncodes a server-sideSocks5Messageinto aByteBuf. -
Uses of ChannelHandler in io.netty.handler.codec.spdy
Classes in io.netty.handler.codec.spdy that implement ChannelHandlerModifier and TypeClassDescriptionclassAChannelHandlerthat encodes and decodes SPDY Frames.final classA combination ofSpdyHttpDecoderandSpdyHttpEncoderclassDecodesSpdySynStreamFrames,SpdySynReplyFrames, andSpdyDataFrames intoFullHttpRequests andFullHttpResponses.classEncodesHttpRequests,HttpResponses, andHttpContents intoSpdySynStreamFrames andSpdySynReplyFrames.classMessageToMessageCodecthat takes care of adding the rightSpdyHttpHeaders.Names.STREAM_IDto theHttpMessageif one is not present.classManages streams within a SPDY session. -
Uses of ChannelHandler in io.netty.handler.codec.stomp
Classes in io.netty.handler.codec.stomp that implement ChannelHandlerModifier and TypeClassDescriptionclassAChannelHandlerthat aggregates anStompHeadersSubframeand its followingStompContentSubframes into a singleStompFrame.classclass -
Uses of ChannelHandler in io.netty.handler.codec.string
Classes in io.netty.handler.codec.string that implement ChannelHandlerModifier and TypeClassDescriptionclassclassclass -
Uses of ChannelHandler in io.netty.handler.codec.xml
Classes in io.netty.handler.codec.xml that implement ChannelHandlerModifier and TypeClassDescriptionclassAsync XML decoder based on Aalto XML parser.classA 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 ChannelHandlerModifier and TypeClassDescriptionclassTheFlowControlHandlerensures that only one message perread()is sent downstream. -
Uses of ChannelHandler in io.netty.handler.flush
Classes in io.netty.handler.flush that implement ChannelHandlerModifier and TypeClassDescriptionclassChannelDuplexHandlerwhich consolidatesChannel.flush()/ChannelHandlerContext.flush()operations (which also includesChannel.writeAndFlush(Object)/Channel.writeAndFlush(Object, ChannelPromise)andChannelOutboundInvoker.writeAndFlush(Object)/ChannelOutboundInvoker.writeAndFlush(Object, ChannelPromise)). -
Uses of ChannelHandler in io.netty.handler.ipfilter
Classes in io.netty.handler.ipfilter that implement ChannelHandlerModifier and TypeClassDescriptionclassAbstractRemoteAddressFilter<T extends SocketAddress>This class provides the functionality to either accept or reject newChannels based on their IP address.classThis class allows one to filter newChannels based on theIpSubnetFilters passed to its constructor.classThis class allows one to filter newChannels based on theIpFilterRules passed to its constructor.classThis class allows one to ensure that at all times for every IP address there is at most oneChannelconnected to the server. -
Uses of ChannelHandler in io.netty.handler.logging
Classes in io.netty.handler.logging that implement ChannelHandlerModifier and TypeClassDescriptionclassAChannelHandlerthat logs all events using a logging framework. -
Uses of ChannelHandler in io.netty.handler.pcap
Classes in io.netty.handler.pcap that implement ChannelHandlerModifier and TypeClassDescriptionfinal classPcapWriteHandlercapturesByteBuffromSocketChannel/ServerChannelorDatagramPacketand writes it into PcapOutputStream. -
Uses of ChannelHandler in io.netty.handler.proxy
Classes in io.netty.handler.proxy that implement ChannelHandlerModifier and TypeClassDescriptionfinal classHandler that establishes a blind forwarding proxy tunnel using HTTP/1.1 CONNECT request.classA common abstraction for protocols that establish blind forwarding proxy tunnels.final classHandler that establishes a blind forwarding proxy tunnel using SOCKS4 protocol.final classHandler 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 ChannelHandlerModifier and TypeClassDescriptionclassEnables SNI (Server Name Indication) extension for server side SSL.classConfigures aChannelPipelinedepending on the application-level protocol negotiation result ofSslHandler.classOptionalSslHandleris a utility decoder to support both SSL and non-SSL handlers based on the first message received.classEnables SNI (Server Name Indication) extension for server side SSL.classByteToMessageDecoderwhich allows to be notified once a fullClientHellowas received.classclassTheSslMasterKeyHandleris a channel-handler you can include in your pipeline to consume the master key invalid input: '&' session identifier for a TLS session.Methods in io.netty.handler.ssl that return ChannelHandlerModifier and TypeMethodDescriptionprotected ChannelHandlerOptionalSslHandler.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 ChannelHandlerModifier and TypeClassDescriptionclassA handler for SSL clients to handle and act upon stapled OCSP responses.classOcspServerCertificateValidatorvalidates incoming server's certificate using OCSP. -
Uses of ChannelHandler in io.netty.handler.stream
Classes in io.netty.handler.stream that implement ChannelHandlerModifier and TypeClassDescriptionclassAChannelHandlerthat adds support for writing a large data stream asynchronously neither spending a lot of memory nor gettingOutOfMemoryError. -
Uses of ChannelHandler in io.netty.handler.timeout
Classes in io.netty.handler.timeout that implement ChannelHandlerModifier and TypeClassDescriptionclassTriggers anIdleStateEventwhen aChannelhas not performed read, write, or both operation for a while.classRaises aReadTimeoutExceptionwhen no data was read within a certain period of time.classRaises aWriteTimeoutExceptionwhen 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 ChannelHandlerModifier and TypeClassDescriptionclassAbstractTrafficShapingHandler allows to limit the global bandwidth (seeGlobalTrafficShapingHandler) or per session bandwidth (seeChannelTrafficShapingHandler), as traffic shaping.classThis implementation of theAbstractTrafficShapingHandleris for channel traffic shaping, that is to say a per channel limitation of the bandwidth.classThis implementation of theAbstractTrafficShapingHandleris 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.
This version shall not be in the same pipeline than other TrafficShapingHandler.
The general use should be as follow:
Create your unique GlobalChannelTrafficShapingHandler like:
GlobalChannelTrafficShapingHandler myHandler = new GlobalChannelTrafficShapingHandler(executor);
The executor could be the underlying IO worker pool
pipeline.addLast(myHandler);
Note that this handler has a Pipeline Coverage of "all" which means only one such handler must be created and shared among all channels as the counter must be shared among all channels.
Other arguments can be passed like write or read limitation (in bytes/s where 0 means no limitation) or the check interval (in millisecond) that represents the delay between two computations of the bandwidth and so the call back of the doAccounting method (0 means no accounting at all).
Note that as this is a fusion of both Global and Channel Traffic Shaping, limits are in 2 sets, respectively Global and Channel.
A value of 0 means no accounting for checkInterval.classThis implementation of theAbstractTrafficShapingHandleris for global traffic shaping, that is to say a global limitation of the bandwidth, whatever the number of opened channels.
ChannelPipeline.addAfter(String, String, ChannelHandler)