Class ChannelOutboundHandlerAdapter

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

All Implemented Interfaces:: ChannelHandler, ChannelOutboundHandler

Direct Known Subclasses:: DynamicAddressConnectHandler, MessageToByteEncoder, MessageToMessageEncoder, ResolveAddressHandler, WriteTimeoutHandler

public class ChannelOutboundHandlerAdapter extends ChannelHandlerAdapter implements ChannelOutboundHandler

Skeleton implementation of a ChannelOutboundHandler. This implementation just forwards each method call via the ChannelHandlerContext.

Nested Class Summary

Nested classes/interfaces inherited from interface ChannelHandler
ChannelHandler.Sharable
Constructor Summary

Constructors

Constructor

Description

ChannelOutboundHandlerAdapter()
Method Summary

Modifier and Type

Method

Description

void

bind (ChannelHandlerContext ctx, SocketAddress localAddress, ChannelPromise promise)

Calls ChannelOutboundInvoker.bind(SocketAddress, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.

void

close (ChannelHandlerContext ctx, ChannelPromise promise)

Calls ChannelOutboundInvoker.close(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.

void

connect (ChannelHandlerContext ctx, SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise)

Calls ChannelOutboundInvoker.connect(SocketAddress, SocketAddress, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.

void

deregister (ChannelHandlerContext ctx, ChannelPromise promise)

Calls ChannelOutboundInvoker.deregister(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.

void

disconnect (ChannelHandlerContext ctx, ChannelPromise promise)

Calls ChannelOutboundInvoker.disconnect(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.

void

flush (ChannelHandlerContext ctx)

Calls ChannelHandlerContext.flush() to forward to the next ChannelOutboundHandler in the ChannelPipeline.

void

read (ChannelHandlerContext ctx)

Calls ChannelHandlerContext.read() to forward to the next ChannelOutboundHandler in the ChannelPipeline.

void

write (ChannelHandlerContext ctx, Object msg, ChannelPromise promise)

Calls ChannelOutboundInvoker.write(Object, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.

Methods inherited from class ChannelHandlerAdapter
ensureNotSharable, exceptionCaught, handlerAdded, handlerRemoved, isSharable

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ChannelHandler
exceptionCaught, handlerAdded, handlerRemoved

Constructor Details
- ChannelOutboundHandlerAdapter
  
  public ChannelOutboundHandlerAdapter()
Method Details
- bind
  
  public void bind(ChannelHandlerContext ctx, SocketAddress localAddress, ChannelPromise promise) throws Exception
  
  Calls ChannelOutboundInvoker.bind(SocketAddress, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.
  
  Specified by:
  
  bind in interface ChannelOutboundHandler
  
  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 occurs
- connect
  
  public void connect(ChannelHandlerContext ctx, SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise) throws Exception
  
  Calls ChannelOutboundInvoker.connect(SocketAddress, SocketAddress, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.
  
  Specified by:
  
  connect in interface ChannelOutboundHandler
  
  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 occurs
- disconnect
  
  public void disconnect(ChannelHandlerContext ctx, ChannelPromise promise) throws Exception
  
  Calls ChannelOutboundInvoker.disconnect(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.
  
  Specified by:
  
  disconnect in interface ChannelOutboundHandler
  
  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 occurs
- close
  
  public void close(ChannelHandlerContext ctx, ChannelPromise promise) throws Exception
  
  Calls ChannelOutboundInvoker.close(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.
  
  Specified by:
  
  close in interface ChannelOutboundHandler
  
  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 occurs
- deregister
  
  public void deregister(ChannelHandlerContext ctx, ChannelPromise promise) throws Exception
  
  Calls ChannelOutboundInvoker.deregister(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.
  
  Specified by:
  
  deregister in interface ChannelOutboundHandler
  
  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 occurs
- read
  
  public void read(ChannelHandlerContext ctx) throws Exception
  
  Calls ChannelHandlerContext.read() to forward to the next ChannelOutboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.
  
  Specified by:
  
  read in interface ChannelOutboundHandler
  
  Throws:
  
  Exception
- write
  
  public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception
  
  Calls ChannelOutboundInvoker.write(Object, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.
  
  Specified by:
  
  write in interface ChannelOutboundHandler
  
  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:
  
  Exception - thrown if an error occurs
- flush
  
  public void flush(ChannelHandlerContext ctx) throws Exception
  
  Calls ChannelHandlerContext.flush() to forward to the next ChannelOutboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.
  
  Specified by:
  
  flush in interface ChannelOutboundHandler
  
  Parameters:
  
  ctx - the ChannelHandlerContext for which the flush operation is made
  
  Throws:
  
  Exception - thrown if an error occurs

Class ChannelOutboundHandlerAdapter

Nested Class Summary

Nested classes/interfaces inherited from interface ChannelHandler

Constructor Summary

Method Summary

Methods inherited from class ChannelHandlerAdapter

Methods inherited from class Object

Methods inherited from interface ChannelHandler

Constructor Details

ChannelOutboundHandlerAdapter

Method Details

bind

connect

disconnect

close

deregister

read

write

flush