All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler

Direct Known Subclasses:

HttpClientCodec, HttpServerCodec, SpdyHttpCodec

public class CombinedChannelDuplexHandler<I extends ChannelInboundHandler,O extends ChannelOutboundHandler>
extends ChannelDuplexHandler 

• Nested Class Summary

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

    ChannelHandler.Sharable

• Constructor Summary

  Constructors

  Modifier	Constructor and Description
  protected	CombinedChannelDuplexHandler () Creates a new uninitialized instance.
  	CombinedChannelDuplexHandler (I inboundHandler, O outboundHandler) Creates a new instance that combines the specified two handlers into one.

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  void	bind (ChannelHandlerContext ctx, java.net.SocketAddress localAddress, ChannelPromise promise) Calls ChannelHandlerContext.bind(SocketAddress, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
  void	channelActive (ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelActive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
  void	channelInactive (ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
  void	channelRead (ChannelHandlerContext ctx, java.lang.Object msg) Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.
  void	channelReadComplete (ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelReadComplete() to forward to the next ChannelInboundHandler in the ChannelPipeline.
  void	channelRegistered (ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelRegistered() to forward to the next ChannelInboundHandler in the ChannelPipeline.
  void	channelUnregistered (ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelUnregistered() to forward to the next ChannelInboundHandler in the ChannelPipeline.
  void	channelWritabilityChanged (ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelWritabilityChanged() to forward to the next ChannelInboundHandler in the ChannelPipeline.
  void	close (ChannelHandlerContext ctx, ChannelPromise promise) Calls ChannelHandlerContext.close(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
  void	connect (ChannelHandlerContext ctx, java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress, ChannelPromise promise) Calls ChannelHandlerContext.connect(SocketAddress, SocketAddress, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
  void	deregister (ChannelHandlerContext ctx, ChannelPromise promise) Calls ChannelHandlerContext.close(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
  void	disconnect (ChannelHandlerContext ctx, ChannelPromise promise) Calls ChannelHandlerContext.disconnect(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
  void	exceptionCaught (ChannelHandlerContext ctx, java.lang.Throwable cause) Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler in the ChannelPipeline.
  void	flush (ChannelHandlerContext ctx) Calls ChannelHandlerContext.flush() to forward to the next ChannelOutboundHandler in the ChannelPipeline.
  void	handlerAdded (ChannelHandlerContext ctx) Do nothing by default, sub-classes may override this method.
  void	handlerRemoved (ChannelHandlerContext ctx) Do nothing by default, sub-classes may override this method.
  protected I	inboundHandler ()
  protected void	init (I inboundHandler, O outboundHandler) Initialized this handler with the specified handlers.
  protected O	outboundHandler ()
  void	read (ChannelHandlerContext ctx) Calls ChannelHandlerContext.read() to forward to the next ChannelOutboundHandler in the ChannelPipeline.
  void	removeInboundHandler () Removes the ChannelInboundHandler that was combined in this CombinedChannelDuplexHandler.
  void	removeOutboundHandler () Removes the ChannelOutboundHandler that was combined in this CombinedChannelDuplexHandler.
  void	userEventTriggered (ChannelHandlerContext ctx, java.lang.Object evt) Calls ChannelHandlerContext.fireUserEventTriggered(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.
  void	write (ChannelHandlerContext ctx, java.lang.Object msg, ChannelPromise promise) Calls ChannelHandlerContext.write(Object, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.

  • Methods inherited from class io.netty.channel.ChannelHandlerAdapter

    ensureNotSharable, isSharable

  • Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

• Constructor Detail

  • CombinedChannelDuplexHandler

    protected CombinedChannelDuplexHandler()

    Creates a new uninitialized instance. A class that extends this handler must invoke init(ChannelInboundHandler, ChannelOutboundHandler) before adding this handler into a ChannelPipeline.

  • CombinedChannelDuplexHandler

    public CombinedChannelDuplexHandler(I inboundHandler,
     O outboundHandler)

    Creates a new instance that combines the specified two handlers into one.

• Method Detail

  • init

    protected final void init(I inboundHandler,
     O outboundHandler)

    Initialized this handler with the specified handlers.

    Throws:

    java.lang.IllegalStateException - if this handler was not constructed via the default constructor or if this handler does not implement all required handler interfaces

    java.lang.IllegalArgumentException - if the specified handlers cannot be combined into one due to a conflict in the type hierarchy

  • inboundHandler

    protected final I inboundHandler()

  • outboundHandler

    protected final O outboundHandler()

  • removeInboundHandler

    public final void removeInboundHandler()

    Removes the ChannelInboundHandler that was combined in this CombinedChannelDuplexHandler.

  • removeOutboundHandler

    public final void removeOutboundHandler()

    Removes the ChannelOutboundHandler that was combined in this CombinedChannelDuplexHandler.

  • handlerAdded

    public void handlerAdded(ChannelHandlerContext ctx)
     throws java.lang.Exception

    Description copied from class: ChannelHandlerAdapter
    Do nothing by default, sub-classes may override this method.

    Specified by:

    handlerAdded in interface ChannelHandler

    Overrides:

    handlerAdded in class ChannelHandlerAdapter

    Throws:

    java.lang.Exception

  • handlerRemoved

    public void handlerRemoved(ChannelHandlerContext ctx)
     throws java.lang.Exception

    Description copied from class: ChannelHandlerAdapter
    Do nothing by default, sub-classes may override this method.

    Specified by:

    handlerRemoved in interface ChannelHandler

    Overrides:

    handlerRemoved in class ChannelHandlerAdapter

    Throws:

    java.lang.Exception

  • channelRegistered

    public void channelRegistered(ChannelHandlerContext ctx)
     throws java.lang.Exception

    Description copied from class: ChannelInboundHandlerAdapter
    Calls ChannelHandlerContext.fireChannelRegistered() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

    Specified by:

    channelRegistered in interface ChannelInboundHandler

    Overrides:

    channelRegistered in class ChannelInboundHandlerAdapter

    Throws:

    java.lang.Exception

  • channelUnregistered

    public void channelUnregistered(ChannelHandlerContext ctx)
     throws java.lang.Exception

    Description copied from class: ChannelInboundHandlerAdapter
    Calls ChannelHandlerContext.fireChannelUnregistered() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

    Specified by:

    channelUnregistered in interface ChannelInboundHandler

    Overrides:

    channelUnregistered in class ChannelInboundHandlerAdapter

    Throws:

    java.lang.Exception

  • channelActive

    public void channelActive(ChannelHandlerContext ctx)
     throws java.lang.Exception

    Description copied from class: ChannelInboundHandlerAdapter
    Calls ChannelHandlerContext.fireChannelActive() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

    Specified by:

    channelActive in interface ChannelInboundHandler

    Overrides:

    channelActive in class ChannelInboundHandlerAdapter

    Throws:

    java.lang.Exception

  • channelInactive

    public void channelInactive(ChannelHandlerContext ctx)
     throws java.lang.Exception

    Description copied from class: ChannelInboundHandlerAdapter
    Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

    Specified by:

    channelInactive in interface ChannelInboundHandler

    Overrides:

    channelInactive in class ChannelInboundHandlerAdapter

    Throws:

    java.lang.Exception

  • exceptionCaught

    public void exceptionCaught(ChannelHandlerContext ctx,
     java.lang.Throwable cause)
     throws java.lang.Exception

    Description copied from class: ChannelInboundHandlerAdapter
    Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

    Specified by:

    exceptionCaught in interface ChannelHandler

    Specified by:

    exceptionCaught in interface ChannelInboundHandler

    Overrides:

    exceptionCaught in class ChannelInboundHandlerAdapter

    Throws:

    java.lang.Exception

  • userEventTriggered

    public void userEventTriggered(ChannelHandlerContext ctx,
     java.lang.Object evt)
     throws java.lang.Exception

    Description copied from class: ChannelInboundHandlerAdapter
    Calls ChannelHandlerContext.fireUserEventTriggered(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

    Specified by:

    userEventTriggered in interface ChannelInboundHandler

    Overrides:

    userEventTriggered in class ChannelInboundHandlerAdapter

    Throws:

    java.lang.Exception

  • channelRead

    public void channelRead(ChannelHandlerContext ctx,
     java.lang.Object msg)
     throws java.lang.Exception

    Description copied from class: ChannelInboundHandlerAdapter
    Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

    Specified by:

    channelRead in interface ChannelInboundHandler

    Overrides:

    channelRead in class ChannelInboundHandlerAdapter

    Throws:

    java.lang.Exception

  • channelReadComplete

    public void channelReadComplete(ChannelHandlerContext ctx)
     throws java.lang.Exception

    Description copied from class: ChannelInboundHandlerAdapter
    Calls ChannelHandlerContext.fireChannelReadComplete() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

    Specified by:

    channelReadComplete in interface ChannelInboundHandler

    Overrides:

    channelReadComplete in class ChannelInboundHandlerAdapter

    Throws:

    java.lang.Exception

  • channelWritabilityChanged

    public void channelWritabilityChanged(ChannelHandlerContext ctx)
     throws java.lang.Exception

    Description copied from class: ChannelInboundHandlerAdapter
    Calls ChannelHandlerContext.fireChannelWritabilityChanged() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

    Specified by:

    channelWritabilityChanged in interface ChannelInboundHandler

    Overrides:

    channelWritabilityChanged in class ChannelInboundHandlerAdapter

    Throws:

    java.lang.Exception

  • bind

    public void bind(ChannelHandlerContext ctx,
     java.net.SocketAddress localAddress,
     ChannelPromise promise)
     throws java.lang.Exception

    Description copied from class: ChannelDuplexHandler
    Calls ChannelHandlerContext.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

    Overrides:

    bind in class ChannelDuplexHandler

    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

    public void connect(ChannelHandlerContext ctx,
     java.net.SocketAddress remoteAddress,
     java.net.SocketAddress localAddress,
     ChannelPromise promise)
     throws java.lang.Exception

    Description copied from class: ChannelDuplexHandler
    Calls ChannelHandlerContext.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

    Overrides:

    connect in class ChannelDuplexHandler

    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

    public void disconnect(ChannelHandlerContext ctx,
     ChannelPromise promise)
     throws java.lang.Exception

    Description copied from class: ChannelDuplexHandler
    Calls ChannelHandlerContext.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

    Overrides:

    disconnect in class ChannelDuplexHandler

    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

    public void close(ChannelHandlerContext ctx,
     ChannelPromise promise)
     throws java.lang.Exception

    Description copied from class: ChannelDuplexHandler
    Calls ChannelHandlerContext.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

    Overrides:

    close in class ChannelDuplexHandler

    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

    public void deregister(ChannelHandlerContext ctx,
     ChannelPromise promise)
     throws java.lang.Exception

    Description copied from class: ChannelDuplexHandler
    Calls ChannelHandlerContext.close(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

    Overrides:

    deregister in class ChannelDuplexHandler

    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

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

    Description copied from class: ChannelDuplexHandler
    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

    Overrides:

    read in class ChannelDuplexHandler

    Throws:

    java.lang.Exception

  • write

    public void write(ChannelHandlerContext ctx,
     java.lang.Object msg,
     ChannelPromise promise)
     throws java.lang.Exception

    Description copied from class: ChannelDuplexHandler
    Calls ChannelHandlerContext.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

    Overrides:

    write in class ChannelDuplexHandler

    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

    public void flush(ChannelHandlerContext ctx)
     throws java.lang.Exception

    Description copied from class: ChannelDuplexHandler
    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

    Overrides:

    flush in class ChannelDuplexHandler

    Parameters:

    ctx - the ChannelHandlerContext for which the flush operation is made

    Throws:

    java.lang.Exception - thrown if an error occurs