io.netty.channel

Interface ChannelOutboundHandler

All Superinterfaces:

ChannelHandler

All Known Implementing Classes:

ChannelDuplexHandler, ChannelOutboundHandlerAdapter, CombinedChannelDuplexHandler

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

Methods

Modifier and Type	Method and Description
void	bind(ChannelHandlerContext ctx, 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, SocketAddress remoteAddress, 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	read(ChannelHandlerContext ctx) Intercepts ChannelOutboundInvoker.read().
void	write(ChannelHandlerContext ctx, MessageList<Object> msgs, ChannelPromise promise) Called once a flush operation is made and so the outbound data should be written.

Methods inherited from interface io.netty.channel.ChannelHandler

exceptionCaught, handlerAdded, handlerRemoved

Method Detail

bind

void bind(ChannelHandlerContext ctx,
        SocketAddress localAddress,
        ChannelPromise promise)
          throws 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:

Exception - thrown if an error accour

connect

void connect(ChannelHandlerContext ctx,
           SocketAddress remoteAddress,
           SocketAddress localAddress,
           ChannelPromise promise)
             throws 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:

Exception - thrown if an error accour

disconnect

void disconnect(ChannelHandlerContext ctx,
              ChannelPromise promise)
                throws 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:

Exception - thrown if an error accour

close

void close(ChannelHandlerContext ctx,
         ChannelPromise promise)
           throws 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:

Exception - thrown if an error accour

deregister

void deregister(ChannelHandlerContext ctx,
              ChannelPromise promise)
                throws 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:

Exception - thrown if an error accour

read

void read(ChannelHandlerContext ctx)
          throws Exception

Intercepts ChannelOutboundInvoker.read().

Throws:

Exception

write

void write(ChannelHandlerContext ctx,
         MessageList<Object> msgs,
         ChannelPromise promise)
           throws Exception

Called once a flush operation is made and so the outbound data should be written.

Parameters:

ctx - the ChannelHandlerContext for which the flush operation is made

promise - the ChannelPromise to notify once the operation completes

Throws:

Exception - thrown if an error accour