Package io.netty.channel
Interface ChannelOutboundHandler
-
- All Superinterfaces:
ChannelHandler
- All Known Subinterfaces:
WebSocketFrameEncoder
- All Known Implementing Classes:
AbstractBinaryMemcacheEncoder
,AbstractMemcacheObjectEncoder
,AbstractSniHandler
,AbstractTrafficShapingHandler
,Base64Encoder
,BinaryMemcacheClientCodec
,BinaryMemcacheRequestEncoder
,BinaryMemcacheResponseEncoder
,BinaryMemcacheServerCodec
,BrotliEncoder
,ByteArrayEncoder
,ByteToMessageCodec
,Bzip2Encoder
,ChannelDuplexHandler
,ChannelOutboundHandlerAdapter
,ChannelTrafficShapingHandler
,ChunkedWriteHandler
,CombinedChannelDuplexHandler
,CompatibleMarshallingEncoder
,CompatibleObjectEncoder
,CorsHandler
,DatagramDnsQueryEncoder
,DatagramDnsResponseEncoder
,DatagramPacketEncoder
,DynamicAddressConnectHandler
,FastLzFrameEncoder
,FlowControlHandler
,FlushConsolidationHandler
,GlobalChannelTrafficShapingHandler
,GlobalTrafficShapingHandler
,HAProxyMessageEncoder
,Http2ChannelDuplexHandler
,Http2ConnectionHandler
,Http2FrameCodec
,Http2MultiplexCodec
,Http2MultiplexHandler
,Http2StreamFrameToHttpObjectCodec
,HttpClientCodec
,HttpClientUpgradeHandler
,HttpContentCompressor
,HttpContentEncoder
,HttpObjectEncoder
,HttpProxyHandler
,HttpRequestEncoder
,HttpResponseEncoder
,HttpServerCodec
,HttpServerKeepAliveHandler
,HttpToHttp2ConnectionHandler
,IdleStateHandler
,JdkZlibEncoder
,JZlibEncoder
,LengthFieldPrepender
,LineEncoder
,LoggingHandler
,Lz4FrameEncoder
,LzfEncoder
,LzmaFrameEncoder
,MarshallingEncoder
,MessageToByteEncoder
,MessageToMessageCodec
,MessageToMessageEncoder
,MqttEncoder
,ObjectEncoder
,PcapWriteHandler
,ProtobufEncoder
,ProtobufEncoderNano
,ProtobufVarint32LengthFieldPrepender
,ProxyHandler
,ReadTimeoutHandler
,RedisEncoder
,ResolveAddressHandler
,RtspEncoder
,RtspObjectEncoder
,RtspRequestEncoder
,RtspResponseEncoder
,SctpOutboundByteStreamHandler
,SmtpRequestEncoder
,SnappyFramedEncoder
,SnappyFrameEncoder
,SniHandler
,Socks4ClientEncoder
,Socks4ProxyHandler
,Socks4ServerEncoder
,Socks5ClientEncoder
,Socks5ProxyHandler
,Socks5ServerEncoder
,SocksMessageEncoder
,SpdyFrameCodec
,SpdyHttpCodec
,SpdyHttpEncoder
,SpdyHttpResponseStreamIdHandler
,SpdySessionHandler
,SslClientHelloHandler
,SslHandler
,StompSubframeEncoder
,StringEncoder
,TcpDnsQueryEncoder
,TcpDnsResponseEncoder
,WebSocket00FrameEncoder
,WebSocket07FrameEncoder
,WebSocket08FrameEncoder
,WebSocket13FrameEncoder
,WebSocketClientCompressionHandler
,WebSocketClientExtensionHandler
,WebSocketClientProtocolHandler
,WebSocketExtensionEncoder
,WebSocketServerCompressionHandler
,WebSocketServerExtensionHandler
,WebSocketServerProtocolHandler
,WriteTimeoutHandler
,ZlibEncoder
,ZstdEncoder
public interface ChannelOutboundHandler extends ChannelHandler
ChannelHandler
which will get notified for IO-outbound-operations.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler
ChannelHandler.Sharable
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
bind(ChannelHandlerContext ctx, java.net.SocketAddress localAddress, ChannelPromise promise)
Called once a bind operation is made.void
close(ChannelHandlerContext ctx, ChannelPromise promise)
Called once a close operation is made.void
connect(ChannelHandlerContext ctx, java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress, ChannelPromise promise)
Called once a connect operation is made.void
deregister(ChannelHandlerContext ctx, ChannelPromise promise)
Called once a deregister operation is made from the current registeredEventLoop
.void
disconnect(ChannelHandlerContext ctx, ChannelPromise promise)
Called once a disconnect operation is made.void
flush(ChannelHandlerContext ctx)
Called once a flush operation is made.void
read(ChannelHandlerContext ctx)
InterceptsChannelHandlerContext.read()
.void
write(ChannelHandlerContext ctx, java.lang.Object msg, ChannelPromise promise)
Called once a write operation is made.-
Methods inherited from interface io.netty.channel.ChannelHandler
exceptionCaught, handlerAdded, handlerRemoved
-
-
-
-
Method Detail
-
bind
void bind(ChannelHandlerContext ctx, java.net.SocketAddress localAddress, ChannelPromise promise) throws java.lang.Exception
Called once a bind operation is made.- Parameters:
ctx
- theChannelHandlerContext
for which the bind operation is madelocalAddress
- theSocketAddress
to which it should boundpromise
- theChannelPromise
to notify once the operation completes- Throws:
java.lang.Exception
- thrown if an error occurs
-
connect
void connect(ChannelHandlerContext ctx, java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress, ChannelPromise promise) throws java.lang.Exception
Called once a connect operation is made.- Parameters:
ctx
- theChannelHandlerContext
for which the connect operation is maderemoteAddress
- theSocketAddress
to which it should connectlocalAddress
- theSocketAddress
which is used as source on connectpromise
- theChannelPromise
to notify once the operation completes- Throws:
java.lang.Exception
- thrown if an error occurs
-
disconnect
void disconnect(ChannelHandlerContext ctx, ChannelPromise promise) throws java.lang.Exception
Called once a disconnect operation is made.- Parameters:
ctx
- theChannelHandlerContext
for which the disconnect operation is madepromise
- theChannelPromise
to notify once the operation completes- Throws:
java.lang.Exception
- thrown if an error occurs
-
close
void close(ChannelHandlerContext ctx, ChannelPromise promise) throws java.lang.Exception
Called once a close operation is made.- Parameters:
ctx
- theChannelHandlerContext
for which the close operation is madepromise
- theChannelPromise
to notify once the operation completes- Throws:
java.lang.Exception
- thrown if an error occurs
-
deregister
void deregister(ChannelHandlerContext ctx, ChannelPromise promise) throws java.lang.Exception
Called once a deregister operation is made from the current registeredEventLoop
.- Parameters:
ctx
- theChannelHandlerContext
for which the close operation is madepromise
- theChannelPromise
to notify once the operation completes- Throws:
java.lang.Exception
- thrown if an error occurs
-
read
void read(ChannelHandlerContext ctx) throws java.lang.Exception
InterceptsChannelHandlerContext.read()
.- Throws:
java.lang.Exception
-
write
void write(ChannelHandlerContext ctx, java.lang.Object msg, ChannelPromise promise) throws java.lang.Exception
Called once a write operation is made. The write operation will write the messages through theChannelPipeline
. Those are then ready to be flushed to the actualChannel
onceChannel.flush()
is called- Parameters:
ctx
- theChannelHandlerContext
for which the write operation is mademsg
- the message to writepromise
- theChannelPromise
to notify once the operation completes- Throws:
java.lang.Exception
- thrown if an error occurs
-
flush
void flush(ChannelHandlerContext ctx) throws java.lang.Exception
Called once a flush operation is made. The flush operation will try to flush out all previous written messages that are pending.- Parameters:
ctx
- theChannelHandlerContext
for which the flush operation is made- Throws:
java.lang.Exception
- thrown if an error occurs
-
-