io.netty.channel

Class ChannelHandlerAdapter

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

All Implemented Interfaces:

ChannelHandler

Direct Known Subclasses:

ChannelInboundHandlerAdapter, ChannelOutboundHandlerAdapter, CleartextHttp2ServerUpgradeHandler, Http2FrameLogger

public abstract class ChannelHandlerAdapter
extends Object
implements ChannelHandler

Skeleton implementation of a ChannelHandler.

Nested Class Summary

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

ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
ChannelHandlerAdapter()

Method Summary

Modifier and Type	Method and Description
protected void	ensureNotSharable() Throws IllegalStateException if isSharable() returns true
void	exceptionCaught(ChannelHandlerContext ctx, Throwable cause) Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler 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.
boolean	isSharable() Return true if the implementation is Sharable and so can be added to different ChannelPipelines.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelHandlerAdapter

public ChannelHandlerAdapter()

Method Detail

ensureNotSharable

protected void ensureNotSharable()

Throws IllegalStateException if isSharable() returns true

isSharable

public boolean isSharable()

Return true if the implementation is Sharable and so can be added to different ChannelPipelines.

handlerAdded

public void handlerAdded(ChannelHandlerContext ctx)
                  throws Exception

Do nothing by default, sub-classes may override this method.

Specified by:

handlerAdded in interface ChannelHandler

Throws:

Exception

handlerRemoved

public void handlerRemoved(ChannelHandlerContext ctx)
                    throws Exception

Do nothing by default, sub-classes may override this method.

Specified by:

handlerRemoved in interface ChannelHandler

Throws:

Exception

exceptionCaught

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

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

Throws:

Exception