io.netty.channel

Class ChannelHandlerAppender

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelHandlerAppender

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler

public class ChannelHandlerAppender
extends ChannelInboundHandlerAdapter

A ChannelHandler that appends the specified ChannelHandlers right next to itself. By default, it removes itself from the ChannelPipeline once the specified ChannelHandlers are added. Optionally, you can keep it in the ChannelPipeline by specifying a boolean parameter at construction time.

Nested Class Summary

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

ChannelHandler.Sharable

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ChannelHandlerAppender() Creates a new uninitialized instance.
protected	ChannelHandlerAppender(boolean selfRemoval) Creates a new uninitialized instance.
	ChannelHandlerAppender(boolean selfRemoval, ChannelHandler... handlers) Creates a new instance that appends the specified ChannelHandlers right next to itself.
	ChannelHandlerAppender(boolean selfRemoval, Iterable<? extends ChannelHandler> handlers) Creates a new instance that appends the specified ChannelHandlers right next to itself.
	ChannelHandlerAppender(ChannelHandler... handlers) Creates a new instance that appends the specified ChannelHandlers right next to itself.
	ChannelHandlerAppender(Iterable<? extends ChannelHandler> handlers) Creates a new instance that appends the specified ChannelHandlers right next to itself.

Method Summary

Methods

Modifier and Type	Method and Description
protected ChannelHandlerAppender	add(ChannelHandler... handlers) Adds the specified handlers to the list of the appended handlers.
protected ChannelHandlerAppender	add(ChannelHandler handler) Adds the specified handler to the list of the appended handlers with the auto-generated handler name.
protected ChannelHandlerAppender	add(Iterable<? extends ChannelHandler> handlers) Adds the specified handlers to the list of the appended handlers.
protected ChannelHandlerAppender	add(String name, ChannelHandler handler) Adds the specified handler to the list of the appended handlers.
void	handlerAdded(ChannelHandlerContext ctx) Do nothing by default, sub-classes may override this method.
protected <T extends ChannelHandler> T	handlerAt(int index) Returns the index-th appended handler.

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelRead, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

handlerRemoved, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelHandler

handlerRemoved

Constructor Detail

ChannelHandlerAppender

protected ChannelHandlerAppender()

Creates a new uninitialized instance. A class that extends this handler must invoke add(ChannelHandler...) before adding this handler into a ChannelPipeline.

ChannelHandlerAppender

protected ChannelHandlerAppender(boolean selfRemoval)

Creates a new uninitialized instance. A class that extends this handler must invoke add(ChannelHandler...) before adding this handler into a ChannelPipeline.

Parameters:

selfRemoval - true to remove itself from the ChannelPipeline after appending the ChannelHandlers specified via add(ChannelHandler...).

ChannelHandlerAppender

public ChannelHandlerAppender(Iterable<? extends ChannelHandler> handlers)

Creates a new instance that appends the specified ChannelHandlers right next to itself.

ChannelHandlerAppender

public ChannelHandlerAppender(ChannelHandler... handlers)

Creates a new instance that appends the specified ChannelHandlers right next to itself.

ChannelHandlerAppender

public ChannelHandlerAppender(boolean selfRemoval,
                      Iterable<? extends ChannelHandler> handlers)

Creates a new instance that appends the specified ChannelHandlers right next to itself.

Parameters:

selfRemoval - true to remove itself from the ChannelPipeline after appending the specified ChannelHandlers

ChannelHandlerAppender

public ChannelHandlerAppender(boolean selfRemoval,
                      ChannelHandler... handlers)

Creates a new instance that appends the specified ChannelHandlers right next to itself.

Parameters:

selfRemoval - true to remove itself from the ChannelPipeline after appending the specified ChannelHandlers

Method Detail

add

protected final ChannelHandlerAppender add(String name,
                         ChannelHandler handler)

Adds the specified handler to the list of the appended handlers.

Parameters:

name - the name of the appended handler. null to auto-generate

handler - the handler to append

Throws:

IllegalStateException - if ChannelHandlerAppender has been added to the pipeline already

add

protected final ChannelHandlerAppender add(ChannelHandler handler)

Adds the specified handler to the list of the appended handlers with the auto-generated handler name.

Parameters:

handler - the handler to append

Throws:

IllegalStateException - if ChannelHandlerAppender has been added to the pipeline already

add

protected final ChannelHandlerAppender add(Iterable<? extends ChannelHandler> handlers)

Adds the specified handlers to the list of the appended handlers. The handlers' names are auto-generated.

Throws:

IllegalStateException - if ChannelHandlerAppender has been added to the pipeline already

add

protected final ChannelHandlerAppender add(ChannelHandler... handlers)

Adds the specified handlers to the list of the appended handlers. The handlers' names are auto-generated.

Throws:

IllegalStateException - if ChannelHandlerAppender has been added to the pipeline already

handlerAt

protected final <T extends ChannelHandler> T handlerAt(int index)

Returns the index-th appended handler.

handlerAdded

public void handlerAdded(ChannelHandlerContext ctx)
                  throws 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:

Exception