All Superinterfaces:

ChannelHandler

All Known Subinterfaces:

WebSocketFrameEncoder

All Known Implementing Classes:

AbstractTrafficShapingHandler, Base64Encoder, ByteArrayEncoder, ByteToMessageCodec, ChannelDuplexHandler, ChannelOutboundHandlerAdapter, ChannelTrafficShapingHandler, ChunkedWriteHandler, CombinedChannelDuplexHandler, CompatibleMarshallingEncoder, CompatibleObjectEncoder, CorsHandler, FlushConsolidationHandler, GlobalChannelTrafficShapingHandler, GlobalTrafficShapingHandler, HttpClientCodec, HttpContentCompressor, HttpContentEncoder, HttpObjectEncoder, HttpRequestEncoder, HttpResponseEncoder, HttpServerCodec, HttpServerKeepAliveHandler, IdleStateHandler, JdkZlibEncoder, JZlibEncoder, LengthFieldPrepender, LoggingHandler, MarshallingEncoder, MessageToByteEncoder, MessageToMessageCodec, MessageToMessageEncoder, ObjectEncoder, ProtobufEncoder, ProtobufVarint32LengthFieldPrepender, ReadTimeoutHandler, RtspEncoder, RtspObjectEncoder, RtspRequestEncoder, RtspResponseEncoder, SctpOutboundByteStreamHandler, SnappyFramedEncoder, SocksMessageEncoder, SpdyFrameCodec, SpdyHttpCodec, SpdyHttpEncoder, SpdyHttpResponseStreamIdHandler, SpdySessionHandler, SslHandler, StringEncoder, WebSocket00FrameEncoder, WebSocket07FrameEncoder, WebSocket08FrameEncoder, WebSocket13FrameEncoder, WriteTimeoutHandler, ZlibEncoder

public interface ChannelOutboundHandler
extends ChannelHandler 

• Nested Class Summary

  • Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

    ChannelHandler.Sharable

• Method Summary

  All Methods

  Modifier and Type	Method and 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 registered EventLoop.
  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) Intercepts ChannelHandlerContext.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 - the ChannelHandlerContext for which the bind operation is made

    localAddress - the SocketAddress to which it should bound

    promise - the ChannelPromise 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 - the ChannelHandlerContext for which the connect operation is made

    remoteAddress - the SocketAddress to which it should connect

    localAddress - the SocketAddress which is used as source on connect

    promise - the ChannelPromise 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 - the ChannelHandlerContext for which the disconnect operation is made

    promise - the ChannelPromise 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 - the ChannelHandlerContext for which the close operation is made

    promise - the ChannelPromise 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 registered EventLoop.

    Parameters:

    ctx - the ChannelHandlerContext for which the close operation is made

    promise - the ChannelPromise to notify once the operation completes

    Throws:

    java.lang.Exception - thrown if an error occurs

  • read

    void read(ChannelHandlerContext ctx)
     throws java.lang.Exception

    Intercepts ChannelHandlerContext.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 the ChannelPipeline. Those are then ready to be flushed to the actual Channel once Channel.flush() is called

    Parameters:

    ctx - the ChannelHandlerContext for which the write operation is made

    msg - the message to write

    promise - the ChannelPromise 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 - the ChannelHandlerContext for which the flush operation is made

    Throws:

    java.lang.Exception - thrown if an error occurs