Uses of Interface
io.netty.channel.ChannelOutboundHandler
-
Packages that use ChannelOutboundHandler Package Description io.netty.channel The core channel API which is asynchronous and event-driven abstraction of various transports such as a NIO Channel.io.netty.handler.address Package to dynamically replace local / remoteSocketAddress
.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 io.netty.handler.codec.bytes Encoder and decoder which transform an array of bytes into aByteBuf
and vice versa.io.netty.handler.codec.compression io.netty.handler.codec.dns DNS codec.io.netty.handler.codec.haproxy Decodes an HAProxy proxy protocol headerio.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.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 BuffersMessage
andMessageNano
into aByteBuf
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 aSerializable
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.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 codecio.netty.handler.codec.string Encoder and decoder which transform aString
into aByteBuf
and vice versa.io.netty.handler.flow Package to control the flow of messages.io.netty.handler.flush Package to control flush behavior.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 tunnelingio.netty.handler.ssl SSL · TLS implementation based onSSLEngine
io.netty.handler.stream Writes very large data stream asynchronously neither spending a lot of memory nor gettingOutOfMemoryError
.io.netty.handler.timeout Adds support for read and write timeout and idle connection notification using aTimer
.io.netty.handler.traffic Implementation of a Traffic Shaping Handler and Dynamic Statistics. -
-
Uses of ChannelOutboundHandler in io.netty.channel
Classes in io.netty.channel with type parameters of type ChannelOutboundHandler Modifier and Type Class Description class
CombinedChannelDuplexHandler<I extends ChannelInboundHandler,O extends ChannelOutboundHandler>
Classes in io.netty.channel that implement ChannelOutboundHandler Modifier and Type Class Description class
ChannelDuplexHandler
ChannelHandler
implementation which represents a combination out of aChannelInboundHandler
and theChannelOutboundHandler
.class
ChannelOutboundHandlerAdapter
Skeleton implementation of aChannelOutboundHandler
.class
CombinedChannelDuplexHandler<I extends ChannelInboundHandler,O extends ChannelOutboundHandler>
-
Uses of ChannelOutboundHandler in io.netty.handler.address
Classes in io.netty.handler.address that implement ChannelOutboundHandler Modifier and Type Class Description class
DynamicAddressConnectHandler
ChannelOutboundHandler
implementation which allows to dynamically replace the usedremoteAddress
and / orlocalAddress
when making a connection attempt.class
ResolveAddressHandler
ChannelOutboundHandlerAdapter
which will resolve theSocketAddress
that is passed toResolveAddressHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise)
if it is not already resolved and theAddressResolver
supports the type ofSocketAddress
. -
Uses of ChannelOutboundHandler in io.netty.handler.codec
Classes in io.netty.handler.codec that implement ChannelOutboundHandler Modifier and Type Class Description class
ByteToMessageCodec<I>
A Codec for on-the-fly encoding/decoding of bytes to messages and vise-versa.class
DatagramPacketEncoder<M>
An encoder that encodes the content inAddressedEnvelope
toDatagramPacket
using the specified message encoder.class
LengthFieldPrepender
An encoder that prepends the length of the message.class
MessageToByteEncoder<I>
ChannelOutboundHandlerAdapter
which encodes message in a stream-like fashion from one message to anByteBuf
.class
MessageToMessageCodec<INBOUND_IN,OUTBOUND_IN>
A Codec for on-the-fly encoding/decoding of message.class
MessageToMessageEncoder<I>
ChannelOutboundHandlerAdapter
which encodes from one message to an other message For example here is an implementation which decodes anInteger
to anString
. -
Uses of ChannelOutboundHandler in io.netty.handler.codec.base64
Classes in io.netty.handler.codec.base64 that implement ChannelOutboundHandler Modifier and Type Class Description class
Base64Encoder
-
Uses of ChannelOutboundHandler in io.netty.handler.codec.bytes
Classes in io.netty.handler.codec.bytes that implement ChannelOutboundHandler Modifier and Type Class Description class
ByteArrayEncoder
Encodes the requested array of bytes into aByteBuf
. -
Uses of ChannelOutboundHandler in io.netty.handler.codec.compression
Classes in io.netty.handler.codec.compression that implement ChannelOutboundHandler Modifier and Type Class Description class
BrotliEncoder
Compress aByteBuf
with the Brotli compression.class
Bzip2Encoder
Compresses aByteBuf
using the Bzip2 algorithm.class
FastLzFrameEncoder
Compresses aByteBuf
using the FastLZ algorithm.class
JdkZlibEncoder
Compresses aByteBuf
using the deflate algorithm.class
JZlibEncoder
Compresses aByteBuf
using the deflate algorithm.class
Lz4FrameEncoder
Compresses aByteBuf
using the LZ4 format.class
LzfEncoder
Compresses aByteBuf
using the LZF format.class
LzmaFrameEncoder
Compresses aByteBuf
using the LZMA algorithm.class
SnappyFramedEncoder
Deprecated.UseSnappyFrameEncoder
instead.class
SnappyFrameEncoder
Compresses aByteBuf
using the Snappy framing format.class
ZlibEncoder
Compresses aByteBuf
using the deflate algorithm.class
ZstdEncoder
Compresses aByteBuf
using the Zstandard algorithm. -
Uses of ChannelOutboundHandler in io.netty.handler.codec.dns
Classes in io.netty.handler.codec.dns that implement ChannelOutboundHandler Modifier and Type Class Description class
DatagramDnsQueryEncoder
class
DatagramDnsResponseEncoder
class
TcpDnsQueryEncoder
class
TcpDnsResponseEncoder
-
Uses of ChannelOutboundHandler in io.netty.handler.codec.haproxy
Classes in io.netty.handler.codec.haproxy that implement ChannelOutboundHandler Modifier and Type Class Description class
HAProxyMessageEncoder
Encodes an HAProxy proxy protocol message -
Uses of ChannelOutboundHandler in io.netty.handler.codec.http
Classes in io.netty.handler.codec.http that implement ChannelOutboundHandler Modifier and Type Class Description class
HttpClientCodec
A combination ofHttpRequestEncoder
andHttpResponseDecoder
which enables easier client side HTTP implementation.class
HttpClientUpgradeHandler
Client-side handler for handling an HTTP upgrade handshake to another protocol.class
HttpContentCompressor
Compresses anHttpMessage
and anHttpContent
ingzip
ordeflate
encoding while respecting the"Accept-Encoding"
header.class
HttpContentEncoder
Encodes the content of the outboundHttpResponse
andHttpContent
.class
HttpObjectEncoder<H extends HttpMessage>
class
HttpRequestEncoder
class
HttpResponseEncoder
class
HttpServerCodec
A combination ofHttpRequestDecoder
andHttpResponseEncoder
which enables easier server side HTTP implementation.class
HttpServerKeepAliveHandler
HttpServerKeepAliveHandler helps close persistent connections when appropriate. -
Uses of ChannelOutboundHandler in io.netty.handler.codec.http.cors
Classes in io.netty.handler.codec.http.cors that implement ChannelOutboundHandler Modifier and Type Class Description class
CorsHandler
Handles Cross Origin Resource Sharing (CORS) requests. -
Uses of ChannelOutboundHandler in io.netty.handler.codec.http.websocketx
Subinterfaces of ChannelOutboundHandler in io.netty.handler.codec.http.websocketx Modifier and Type Interface Description interface
WebSocketFrameEncoder
Marker interface which all WebSocketFrame encoders need to implement.Classes in io.netty.handler.codec.http.websocketx that implement ChannelOutboundHandler Modifier and Type Class Description class
WebSocket00FrameEncoder
Encodes aWebSocketFrame
into aByteBuf
.class
WebSocket07FrameEncoder
Encodes a web socket frame into wire protocol version 7 format.class
WebSocket08FrameEncoder
Encodes a web socket frame into wire protocol version 8 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
WebSocketServerProtocolHandler
This handler does all the heavy lifting for you to run a websocket server. -
Uses of ChannelOutboundHandler in io.netty.handler.codec.http.websocketx.extensions
Classes in io.netty.handler.codec.http.websocketx.extensions that implement ChannelOutboundHandler Modifier and Type Class Description class
WebSocketClientExtensionHandler
This handler negotiates and initializes the WebSocket Extensions.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 ChannelOutboundHandler in io.netty.handler.codec.http.websocketx.extensions.compression
Classes in io.netty.handler.codec.http.websocketx.extensions.compression that implement ChannelOutboundHandler Modifier and Type Class 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 ChannelOutboundHandler in io.netty.handler.codec.http2
Classes in io.netty.handler.codec.http2 that implement ChannelOutboundHandler Modifier and Type Class Description class
Http2ChannelDuplexHandler
AChannelDuplexHandler
providing additional functionality for HTTP/2.class
Http2ConnectionHandler
Provides the default implementation for processing inbound frame events and delegates to aHttp2FrameListener
class
Http2FrameCodec
This API is very immature. The Http2Connection-based API is currently preferred over this API.class
Http2MultiplexCodec
Deprecated.useHttp2FrameCodecBuilder
together withHttp2MultiplexHandler
.class
Http2MultiplexHandler
An HTTP/2 handler that creates child channels for each stream.class
Http2StreamFrameToHttpObjectCodec
This handler converts fromHttp2StreamFrame
toHttpObject
, and back.class
HttpToHttp2ConnectionHandler
Translates HTTP/1.x object writes into HTTP/2 frames. -
Uses of ChannelOutboundHandler in io.netty.handler.codec.marshalling
Classes in io.netty.handler.codec.marshalling that implement ChannelOutboundHandler Modifier and Type Class Description class
CompatibleMarshallingEncoder
MessageToByteEncoder
implementation which uses JBoss Marshalling to marshal an Object.class
MarshallingEncoder
MessageToByteEncoder
implementation which uses JBoss Marshalling to marshal an Object. -
Uses of ChannelOutboundHandler in io.netty.handler.codec.memcache
Classes in io.netty.handler.codec.memcache that implement ChannelOutboundHandler Modifier and Type Class Description class
AbstractMemcacheObjectEncoder<M extends MemcacheMessage>
A general purposeAbstractMemcacheObjectEncoder
that encodesMemcacheMessage
s. -
Uses of ChannelOutboundHandler in io.netty.handler.codec.memcache.binary
Classes in io.netty.handler.codec.memcache.binary that implement ChannelOutboundHandler Modifier and Type Class Description class
AbstractBinaryMemcacheEncoder<M extends BinaryMemcacheMessage>
AMessageToByteEncoder
that encodes binary memcache messages into bytes.class
BinaryMemcacheClientCodec
The client codec that combines the proper encoder and decoder.class
BinaryMemcacheRequestEncoder
The encoder part which takes care of encoding the request 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 ChannelOutboundHandler in io.netty.handler.codec.mqtt
Classes in io.netty.handler.codec.mqtt that implement ChannelOutboundHandler Modifier and Type Class Description class
MqttEncoder
-
Uses of ChannelOutboundHandler in io.netty.handler.codec.protobuf
Classes in io.netty.handler.codec.protobuf that implement ChannelOutboundHandler Modifier and Type Class Description class
ProtobufEncoder
class
ProtobufEncoderNano
class
ProtobufVarint32LengthFieldPrepender
An encoder that prepends the Google Protocol Buffers Base 128 Varints integer length field. -
Uses of ChannelOutboundHandler in io.netty.handler.codec.redis
Classes in io.netty.handler.codec.redis that implement ChannelOutboundHandler Modifier and Type Class Description class
RedisEncoder
EncodesRedisMessage
into bytes following RESP (REdis Serialization Protocol). -
Uses of ChannelOutboundHandler in io.netty.handler.codec.rtsp
Classes in io.netty.handler.codec.rtsp that implement ChannelOutboundHandler Modifier and Type Class Description class
RtspEncoder
class
RtspObjectEncoder<H extends HttpMessage>
Deprecated.UseRtspEncoder
instead.class
RtspRequestEncoder
Deprecated.UseRtspEncoder
directly insteadclass
RtspResponseEncoder
Deprecated.UseRtspEncoder
directly instead -
Uses of ChannelOutboundHandler in io.netty.handler.codec.sctp
Classes in io.netty.handler.codec.sctp that implement ChannelOutboundHandler Modifier and Type Class Description class
SctpOutboundByteStreamHandler
A ChannelHandler which transformByteBuf
toSctpMessage
and send it through a specific stream with given protocol identifier. -
Uses of ChannelOutboundHandler in io.netty.handler.codec.serialization
Classes in io.netty.handler.codec.serialization that implement ChannelOutboundHandler Modifier and Type Class Description class
CompatibleObjectEncoder
Deprecated.This class has been deprecated with no replacement, because serialization can be a security liabilityclass
ObjectEncoder
Deprecated.This class has been deprecated with no replacement, because serialization can be a security liability -
Uses of ChannelOutboundHandler in io.netty.handler.codec.smtp
Classes in io.netty.handler.codec.smtp that implement ChannelOutboundHandler Modifier and Type Class Description class
SmtpRequestEncoder
Encoder for SMTP requests. -
Uses of ChannelOutboundHandler in io.netty.handler.codec.socks
Classes in io.netty.handler.codec.socks that implement ChannelOutboundHandler Modifier and Type Class Description class
SocksMessageEncoder
Encodes anSocksMessage
into aByteBuf
. -
Uses of ChannelOutboundHandler in io.netty.handler.codec.socksx.v4
Classes in io.netty.handler.codec.socksx.v4 that implement ChannelOutboundHandler Modifier and Type Class Description class
Socks4ClientEncoder
Encodes aSocks4CommandRequest
into aByteBuf
.class
Socks4ServerEncoder
Encodes aSocks4CommandResponse
into aByteBuf
. -
Uses of ChannelOutboundHandler in io.netty.handler.codec.socksx.v5
Classes in io.netty.handler.codec.socksx.v5 that implement ChannelOutboundHandler Modifier and Type Class Description class
Socks5ClientEncoder
Encodes a client-sideSocks5Message
into aByteBuf
.class
Socks5ServerEncoder
Encodes a server-sideSocks5Message
into aByteBuf
. -
Uses of ChannelOutboundHandler in io.netty.handler.codec.spdy
Classes in io.netty.handler.codec.spdy that implement ChannelOutboundHandler Modifier and Type Class Description class
SpdyFrameCodec
AChannelHandler
that encodes and decodes SPDY Frames.class
SpdyHttpCodec
A combination ofSpdyHttpDecoder
andSpdyHttpEncoder
class
SpdyHttpEncoder
EncodesHttpRequest
s,HttpResponse
s, andHttpContent
s intoSpdySynStreamFrame
s andSpdySynReplyFrame
s.class
SpdyHttpResponseStreamIdHandler
MessageToMessageCodec
that takes care of adding the rightSpdyHttpHeaders.Names.STREAM_ID
to theHttpMessage
if one is not present.class
SpdySessionHandler
Manages streams within a SPDY session. -
Uses of ChannelOutboundHandler in io.netty.handler.codec.stomp
Classes in io.netty.handler.codec.stomp that implement ChannelOutboundHandler Modifier and Type Class Description class
StompSubframeEncoder
-
Uses of ChannelOutboundHandler in io.netty.handler.codec.string
Classes in io.netty.handler.codec.string that implement ChannelOutboundHandler Modifier and Type Class Description class
LineEncoder
Apply a line separator to the requestedString
and encode it into aByteBuf
.class
StringEncoder
Encodes the requestedString
into aByteBuf
. -
Uses of ChannelOutboundHandler in io.netty.handler.flow
Classes in io.netty.handler.flow that implement ChannelOutboundHandler Modifier and Type Class Description class
FlowControlHandler
TheFlowControlHandler
ensures that only one message perread()
is sent downstream. -
Uses of ChannelOutboundHandler in io.netty.handler.flush
Classes in io.netty.handler.flush that implement ChannelOutboundHandler Modifier and Type Class Description class
FlushConsolidationHandler
ChannelDuplexHandler
which consolidatesChannel.flush()
/ChannelHandlerContext.flush()
operations (which also includesChannel.writeAndFlush(Object)
/Channel.writeAndFlush(Object, ChannelPromise)
andChannelOutboundInvoker.writeAndFlush(Object)
/ChannelOutboundInvoker.writeAndFlush(Object, ChannelPromise)
). -
Uses of ChannelOutboundHandler in io.netty.handler.logging
Classes in io.netty.handler.logging that implement ChannelOutboundHandler Modifier and Type Class Description class
LoggingHandler
AChannelHandler
that logs all events using a logging framework. -
Uses of ChannelOutboundHandler in io.netty.handler.pcap
Classes in io.netty.handler.pcap that implement ChannelOutboundHandler Modifier and Type Class Description class
PcapWriteHandler
PcapWriteHandler
capturesByteBuf
fromSocketChannel
/ServerChannel
orDatagramPacket
and writes it into PcapOutputStream
. -
Uses of ChannelOutboundHandler in io.netty.handler.proxy
Classes in io.netty.handler.proxy that implement ChannelOutboundHandler Modifier and Type Class 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 ChannelOutboundHandler in io.netty.handler.ssl
Classes in io.netty.handler.ssl that implement ChannelOutboundHandler Modifier and Type Class Description class
AbstractSniHandler<T>
Enables SNI (Server Name Indication) extension for server side SSL.class
SniHandler
Enables SNI (Server Name Indication) extension for server side SSL.class
SslClientHelloHandler<T>
ByteToMessageDecoder
which allows to be notified once a fullClientHello
was received.class
SslHandler
-
Uses of ChannelOutboundHandler in io.netty.handler.stream
Classes in io.netty.handler.stream that implement ChannelOutboundHandler Modifier and Type Class Description class
ChunkedWriteHandler
AChannelHandler
that adds support for writing a large data stream asynchronously neither spending a lot of memory nor gettingOutOfMemoryError
. -
Uses of ChannelOutboundHandler in io.netty.handler.timeout
Classes in io.netty.handler.timeout that implement ChannelOutboundHandler Modifier and Type Class Description class
IdleStateHandler
Triggers anIdleStateEvent
when aChannel
has not performed read, write, or both operation for a while.class
ReadTimeoutHandler
Raises aReadTimeoutException
when no data was read within a certain period of time.class
WriteTimeoutHandler
Raises aWriteTimeoutException
when a write operation cannot finish in a certain period of time. -
Uses of ChannelOutboundHandler in io.netty.handler.traffic
Classes in io.netty.handler.traffic that implement ChannelOutboundHandler Modifier and Type Class Description class
AbstractTrafficShapingHandler
AbstractTrafficShapingHandler allows to limit the global bandwidth (seeGlobalTrafficShapingHandler
) or per session bandwidth (seeChannelTrafficShapingHandler
), as traffic shaping.class
ChannelTrafficShapingHandler
This implementation of theAbstractTrafficShapingHandler
is for channel traffic shaping, that is to say a per channel limitation of the bandwidth.class
GlobalChannelTrafficShapingHandler
This implementation of theAbstractTrafficShapingHandler
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.
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.class
GlobalTrafficShapingHandler
This implementation of theAbstractTrafficShapingHandler
is for global traffic shaping, that is to say a global limitation of the bandwidth, whatever the number of opened channels.
-