Package io.netty.channel

Interface ChannelPipeline

All Superinterfaces:

ChannelInboundInvoker, ChannelOutboundInvoker, java.lang.Iterable<java.util.Map.Entry<java.lang.String,ChannelHandler>>

All Known Implementing Classes:

DefaultChannelPipeline

public interface ChannelPipeline
extends ChannelInboundInvoker, ChannelOutboundInvoker, java.lang.Iterable<java.util.Map.Entry<java.lang.String,ChannelHandler>>

A list of ChannelHandlers which handles or intercepts inbound events and outbound operations of a Channel. ChannelPipeline implements an advanced form of the Intercepting Filter pattern to give a user full control over how an event is handled and how the ChannelHandlers in a pipeline interact with each other.

Creation of a pipeline

Each channel has its own pipeline and it is created automatically when a new channel is created.

How an event flows in a pipeline

The following diagram describes how I/O events are processed by ChannelHandlers in a ChannelPipeline typically. An I/O event is handled by either a ChannelInboundHandler or a ChannelOutboundHandler and be forwarded to its closest handler by calling the event propagation methods defined in ChannelHandlerContext, such as ChannelHandlerContext.fireChannelRead(Object) and ChannelOutboundInvoker.write(Object).

                                                 I/O Request
                                            via Channel or
                                        ChannelHandlerContext
                                                      |
  +---------------------------------------------------+---------------+
  |                           ChannelPipeline         |               |
  |                                                  \|/              |
  |    +---------------------+            +-----------+----------+    |
  |    | Inbound Handler  N  |            | Outbound Handler  1  |    |
  |    +----------+----------+            +-----------+----------+    |
  |              /|\                                  |               |
  |               |                                  \|/              |
  |    +----------+----------+            +-----------+----------+    |
  |    | Inbound Handler N-1 |            | Outbound Handler  2  |    |
  |    +----------+----------+            +-----------+----------+    |
  |              /|\                                  .               |
  |               .                                   .               |
  | ChannelHandlerContext.fireIN_EVT() ChannelHandlerContext.OUT_EVT()|
  |        [ method call]                       [method call]         |
  |               .                                   .               |
  |               .                                  \|/              |
  |    +----------+----------+            +-----------+----------+    |
  |    | Inbound Handler  2  |            | Outbound Handler M-1 |    |
  |    +----------+----------+            +-----------+----------+    |
  |              /|\                                  |               |
  |               |                                  \|/              |
  |    +----------+----------+            +-----------+----------+    |
  |    | Inbound Handler  1  |            | Outbound Handler  M  |    |
  |    +----------+----------+            +-----------+----------+    |
  |              /|\                                  |               |
  +---------------+-----------------------------------+---------------+
                  |                                  \|/
  +---------------+-----------------------------------+---------------+
  |               |                                   |               |
  |       [ Socket.read() ]                    [ Socket.write() ]     |
  |                                                                   |
  |  Netty Internal I/O Threads (Transport Implementation)            |
  +-------------------------------------------------------------------+
 

An inbound event is handled by the inbound handlers in the bottom-up direction as shown on the left side of the diagram. An inbound handler usually handles the inbound data generated by the I/O thread on the bottom of the diagram. The inbound data is often read from a remote peer via the actual input operation such as SocketChannel.read(ByteBuffer). If an inbound event goes beyond the top inbound handler, it is discarded silently, or logged if it needs your attention.

An outbound event is handled by the outbound handler in the top-down direction as shown on the right side of the diagram. An outbound handler usually generates or transforms the outbound traffic such as write requests. If an outbound event goes beyond the bottom outbound handler, it is handled by an I/O thread associated with the Channel. The I/O thread often performs the actual output operation such as SocketChannel.write(ByteBuffer).

For example, let us assume that we created the following pipeline:

 ChannelPipeline p = ...;
 p.addLast("1", new InboundHandlerA());
 p.addLast("2", new InboundHandlerB());
 p.addLast("3", new OutboundHandlerA());
 p.addLast("4", new OutboundHandlerB());
 p.addLast("5", new InboundOutboundHandlerX());
 

In the example above, the class whose name starts with Inbound means it is an inbound handler. The class whose name starts with Outbound means it is a outbound handler.

In the given example configuration, the handler evaluation order is 1, 2, 3, 4, 5 when an event goes inbound. When an event goes outbound, the order is 5, 4, 3, 2, 1. On top of this principle, ChannelPipeline skips the evaluation of certain handlers to shorten the stack depth:

• 3 and 4 don't implement ChannelInboundHandler, and therefore the actual evaluation order of an inbound event will be: 1, 2, and 5.
• 1 and 2 don't implement ChannelOutboundHandler, and therefore the actual evaluation order of a outbound event will be: 5, 4, and 3.
• If 5 implements both ChannelInboundHandler and ChannelOutboundHandler, the evaluation order of an inbound and a outbound event could be 125 and 543 respectively.

Forwarding an event to the next handler

As you might noticed in the diagram shows, a handler has to invoke the event propagation methods in ChannelHandlerContext to forward an event to its next handler. Those methods include:

• Inbound event propagation methods:
  • ChannelHandlerContext.fireChannelRegistered()
  • ChannelHandlerContext.fireChannelActive()
  • ChannelHandlerContext.fireChannelRead(Object)
  • ChannelHandlerContext.fireChannelReadComplete()
  • ChannelHandlerContext.fireExceptionCaught(Throwable)
  • ChannelHandlerContext.fireUserEventTriggered(Object)
  • ChannelHandlerContext.fireChannelWritabilityChanged()
  • ChannelHandlerContext.fireChannelInactive()
  • ChannelHandlerContext.fireChannelUnregistered()
• Outbound event propagation methods:
  • ChannelOutboundInvoker.bind(SocketAddress, ChannelPromise)
  • ChannelOutboundInvoker.connect(SocketAddress, SocketAddress, ChannelPromise)
  • ChannelOutboundInvoker.write(Object, ChannelPromise)
  • ChannelHandlerContext.flush()
  • ChannelHandlerContext.read()
  • ChannelOutboundInvoker.disconnect(ChannelPromise)
  • ChannelOutboundInvoker.close(ChannelPromise)
  • ChannelOutboundInvoker.deregister(ChannelPromise)

and the following example shows how the event propagation is usually done:

 public class MyInboundHandler extends ChannelInboundHandlerAdapter {
     @Override
     public void channelActive(ChannelHandlerContext ctx) {
         System.out.println("Connected!");
         ctx.fireChannelActive();
     }
 }

 public class MyOutboundHandler extends ChannelOutboundHandlerAdapter {
     @Override
     public void close(ChannelHandlerContext ctx, ChannelPromise promise) {
         System.out.println("Closing ..");
         ctx.close(promise);
     }
 }
 

Building a pipeline

A user is supposed to have one or more ChannelHandlers in a pipeline to receive I/O events (e.g. read) and to request I/O operations (e.g. write and close). For example, a typical server will have the following handlers in each channel's pipeline, but your mileage may vary depending on the complexity and characteristics of the protocol and business logic:

1. Protocol Decoder - translates binary data (e.g. ByteBuf) into a Java object.
2. Protocol Encoder - translates a Java object into binary data.
3. Business Logic Handler - performs the actual business logic.

and it could be represented as shown in the following example:

 ...

 ChannelPipeline pipeline = ch.pipeline();

 pipeline.addLast("decoder", new MyProtocolDecoder());
 pipeline.addLast("encoder", new MyProtocolEncoder());
 pipeline.addLast("handler", new MyBusinessLogicHandler());
 

Thread safety

A ChannelHandler can be added or removed at any time because a ChannelPipeline is thread safe. For example, you can insert an encryption handler when sensitive information is about to be exchanged, and remove it after the exchange.

Method Summary

Modifier and Type	Method	Description
ChannelPipeline	addAfter(EventExecutorGroup group, java.lang.String baseName, java.lang.String name, ChannelHandler handler)	Deprecated. use addAfter(String, String, ChannelHandler)
ChannelPipeline	addAfter(java.lang.String baseName, java.lang.String name, ChannelHandler handler)	Inserts a ChannelHandler after an existing handler of this pipeline.
ChannelPipeline	addBefore(EventExecutorGroup group, java.lang.String baseName, java.lang.String name, ChannelHandler handler)	Deprecated. use addBefore(String, String, ChannelHandler)
ChannelPipeline	addBefore(java.lang.String baseName, java.lang.String name, ChannelHandler handler)	Inserts a ChannelHandler before an existing handler of this pipeline.
ChannelPipeline	addFirst(ChannelHandler... handlers)	Inserts ChannelHandlers at the first position of this pipeline.
ChannelPipeline	addFirst(EventExecutorGroup group, ChannelHandler... handlers)	Deprecated. use addFirst(String, ChannelHandler)
ChannelPipeline	addFirst(EventExecutorGroup group, java.lang.String name, ChannelHandler handler)	Deprecated. use addFirst(String, ChannelHandler)
ChannelPipeline	addFirst(java.lang.String name, ChannelHandler handler)	Inserts a ChannelHandler at the first position of this pipeline.
ChannelPipeline	addLast(ChannelHandler... handlers)	Inserts ChannelHandlers at the last position of this pipeline.
ChannelPipeline	addLast(EventExecutorGroup group, ChannelHandler... handlers)	Deprecated. use addLast(ChannelHandler...)
ChannelPipeline	addLast(EventExecutorGroup group, java.lang.String name, ChannelHandler handler)	Deprecated. use addLast(String, ChannelHandler)
ChannelPipeline	addLast(java.lang.String name, ChannelHandler handler)	Appends a ChannelHandler at the last position of this pipeline.
Channel	channel()	Returns the Channel that this pipeline is attached to.
ChannelHandlerContext	context(ChannelHandler handler)	Returns the context object of the specified ChannelHandler in this pipeline.
ChannelHandlerContext	context(java.lang.Class<? extends ChannelHandler> handlerType)	Returns the context object of the ChannelHandler of the specified type in this pipeline.
ChannelHandlerContext	context(java.lang.String name)	Returns the context object of the ChannelHandler with the specified name in this pipeline.
ChannelPipeline	fireChannelActive()	A Channel is active now, which means it is connected.
ChannelPipeline	fireChannelInactive()	A Channel is inactive now, which means it is closed.
ChannelPipeline	fireChannelRead(java.lang.Object msg)	A Channel received a message.
ChannelPipeline	fireChannelReadComplete()	Triggers an ChannelInboundHandler.channelReadComplete(ChannelHandlerContext) event to the next ChannelInboundHandler in the ChannelPipeline.
ChannelPipeline	fireChannelRegistered()	A Channel was registered to its EventLoop.
ChannelPipeline	fireChannelUnregistered()	A Channel was unregistered from its EventLoop.
ChannelPipeline	fireChannelWritabilityChanged()	Triggers an ChannelInboundHandler.channelWritabilityChanged(ChannelHandlerContext) event to the next ChannelInboundHandler in the ChannelPipeline.
ChannelPipeline	fireExceptionCaught(java.lang.Throwable cause)	A Channel received an Throwable in one of its inbound operations.
ChannelPipeline	fireUserEventTriggered(java.lang.Object event)	A Channel received an user defined event.
ChannelHandler	first()	Returns the first ChannelHandler in this pipeline.
ChannelHandlerContext	firstContext()	Returns the context of the first ChannelHandler in this pipeline.
ChannelPipeline	flush()	Request to flush all pending messages via this ChannelOutboundInvoker.
<T extends ChannelHandler> T	get(java.lang.Class<T> handlerType)	Returns the ChannelHandler of the specified type in this pipeline.
ChannelHandler	get(java.lang.String name)	Returns the ChannelHandler with the specified name in this pipeline.
ChannelHandler	last()	Returns the last ChannelHandler in this pipeline.
ChannelHandlerContext	lastContext()	Returns the context of the last ChannelHandler in this pipeline.
java.util.List<java.lang.String>	names()	Returns the List of the handler names.
default ChannelFuture	newFailedFuture(java.lang.Throwable cause)	Create a new ChannelFuture which is marked as failed already.
default ChannelProgressivePromise	newProgressivePromise()	Return an new ChannelProgressivePromise
default ChannelPromise	newPromise()	Return a new ChannelPromise.
ChannelPipeline	remove(ChannelHandler handler)	Removes the specified ChannelHandler from this pipeline.
<T extends ChannelHandler> T	remove(java.lang.Class<T> handlerType)	Removes the ChannelHandler of the specified type from this pipeline.
ChannelHandler	remove(java.lang.String name)	Removes the ChannelHandler with the specified name from this pipeline.
ChannelHandler	removeFirst()	Removes the first ChannelHandler in this pipeline.
ChannelHandler	removeLast()	Removes the last ChannelHandler in this pipeline.
ChannelPipeline	replace(ChannelHandler oldHandler, java.lang.String newName, ChannelHandler newHandler)	Replaces the specified ChannelHandler with a new handler in this pipeline.
<T extends ChannelHandler> T	replace(java.lang.Class<T> oldHandlerType, java.lang.String newName, ChannelHandler newHandler)	Replaces the ChannelHandler of the specified type with a new handler in this pipeline.
ChannelHandler	replace(java.lang.String oldName, java.lang.String newName, ChannelHandler newHandler)	Replaces the ChannelHandler of the specified name with a new handler in this pipeline.
java.util.Map<java.lang.String,ChannelHandler>	toMap()	Converts this pipeline into an ordered Map whose keys are handler names and whose values are handlers.

Methods inherited from interface io.netty.channel.ChannelOutboundInvoker

bind, bind, close, close, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, newSucceededFuture, read, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

addFirst

ChannelPipeline addFirst(java.lang.String name,
                         ChannelHandler handler)

Inserts a ChannelHandler at the first position of this pipeline.

Parameters:

name - the name of the handler to insert first

handler - the handler to insert first

Throws:

java.lang.IllegalArgumentException - if there's an entry with the same name already in the pipeline

java.lang.NullPointerException - if the specified handler is null

addFirst

@Deprecated
ChannelPipeline addFirst(EventExecutorGroup group,
                         java.lang.String name,
                         ChannelHandler handler)

Deprecated.

use addFirst(String, ChannelHandler)

Inserts a ChannelHandler at the first position of this pipeline.

Parameters:

group - the EventExecutorGroup which will be used to execute the ChannelHandler methods

name - the name of the handler to insert first

handler - the handler to insert first

Throws:

java.lang.IllegalArgumentException - if there's an entry with the same name already in the pipeline

java.lang.NullPointerException - if the specified handler is null

addLast

ChannelPipeline addLast(java.lang.String name,
                        ChannelHandler handler)

Appends a ChannelHandler at the last position of this pipeline.

Parameters:

name - the name of the handler to append

handler - the handler to append

Throws:

java.lang.IllegalArgumentException - if there's an entry with the same name already in the pipeline

java.lang.NullPointerException - if the specified handler is null

addLast

@Deprecated
ChannelPipeline addLast(EventExecutorGroup group,
                        java.lang.String name,
                        ChannelHandler handler)

Deprecated.

use addLast(String, ChannelHandler)

Appends a ChannelHandler at the last position of this pipeline.

Parameters:

group - the EventExecutorGroup which will be used to execute the ChannelHandler methods

name - the name of the handler to append

handler - the handler to append

Throws:

java.lang.IllegalArgumentException - if there's an entry with the same name already in the pipeline

java.lang.NullPointerException - if the specified handler is null

addBefore

ChannelPipeline addBefore(java.lang.String baseName,
                          java.lang.String name,
                          ChannelHandler handler)

Inserts a ChannelHandler before an existing handler of this pipeline.

Parameters:

baseName - the name of the existing handler

name - the name of the handler to insert before

handler - the handler to insert before

Throws:

java.util.NoSuchElementException - if there's no such entry with the specified baseName

java.lang.IllegalArgumentException - if there's an entry with the same name already in the pipeline

java.lang.NullPointerException - if the specified baseName or handler is null

addBefore

@Deprecated
ChannelPipeline addBefore(EventExecutorGroup group,
                          java.lang.String baseName,
                          java.lang.String name,
                          ChannelHandler handler)

Deprecated.

use addBefore(String, String, ChannelHandler)

Inserts a ChannelHandler before an existing handler of this pipeline.

Parameters:

group - the EventExecutorGroup which will be used to execute the ChannelHandler methods

baseName - the name of the existing handler

name - the name of the handler to insert before

handler - the handler to insert before

Throws:

java.util.NoSuchElementException - if there's no such entry with the specified baseName

java.lang.IllegalArgumentException - if there's an entry with the same name already in the pipeline

java.lang.NullPointerException - if the specified baseName or handler is null

addAfter

ChannelPipeline addAfter(java.lang.String baseName,
                         java.lang.String name,
                         ChannelHandler handler)

Inserts a ChannelHandler after an existing handler of this pipeline.

Parameters:

baseName - the name of the existing handler

name - the name of the handler to insert after

handler - the handler to insert after

Throws:

java.util.NoSuchElementException - if there's no such entry with the specified baseName

java.lang.IllegalArgumentException - if there's an entry with the same name already in the pipeline

java.lang.NullPointerException - if the specified baseName or handler is null

addAfter

@Deprecated
ChannelPipeline addAfter(EventExecutorGroup group,
                         java.lang.String baseName,
                         java.lang.String name,
                         ChannelHandler handler)

Deprecated.

use addAfter(String, String, ChannelHandler)

Inserts a ChannelHandler after an existing handler of this pipeline.

Parameters:

group - the EventExecutorGroup which will be used to execute the ChannelHandler methods

baseName - the name of the existing handler

name - the name of the handler to insert after

handler - the handler to insert after

Throws:

java.util.NoSuchElementException - if there's no such entry with the specified baseName

java.lang.IllegalArgumentException - if there's an entry with the same name already in the pipeline

java.lang.NullPointerException - if the specified baseName or handler is null

addFirst

ChannelPipeline addFirst(ChannelHandler... handlers)

Inserts ChannelHandlers at the first position of this pipeline.

Parameters:

handlers - the handlers to insert first

addFirst

@Deprecated
ChannelPipeline addFirst(EventExecutorGroup group,
                         ChannelHandler... handlers)

Deprecated.

use addFirst(String, ChannelHandler)

Inserts ChannelHandlers at the first position of this pipeline.

Parameters:

group - the EventExecutorGroup which will be used to execute the ChannelHandlers methods.

handlers - the handlers to insert first

addLast

ChannelPipeline addLast(ChannelHandler... handlers)

Inserts ChannelHandlers at the last position of this pipeline.

Parameters:

handlers - the handlers to insert last

addLast

@Deprecated
ChannelPipeline addLast(EventExecutorGroup group,
                        ChannelHandler... handlers)

Deprecated.

use addLast(ChannelHandler...)

Inserts ChannelHandlers at the last position of this pipeline.

Parameters:

group - the EventExecutorGroup which will be used to execute the ChannelHandlers methods.

handlers - the handlers to insert last

remove

ChannelPipeline remove(ChannelHandler handler)

Removes the specified ChannelHandler from this pipeline.

Parameters:

handler - the ChannelHandler to remove

Throws:

java.util.NoSuchElementException - if there's no such handler in this pipeline

java.lang.NullPointerException - if the specified handler is null

remove

ChannelHandler remove(java.lang.String name)

Removes the ChannelHandler with the specified name from this pipeline.

Parameters:

name - the name under which the ChannelHandler was stored.

Returns:

the removed handler

Throws:

java.util.NoSuchElementException - if there's no such handler with the specified name in this pipeline

java.lang.NullPointerException - if the specified name is null

remove

<T extends ChannelHandler> T remove(java.lang.Class<T> handlerType)

Removes the ChannelHandler of the specified type from this pipeline.

Type Parameters:

T - the type of the handler

Parameters:

handlerType - the type of the handler

Returns:

the removed handler

Throws:

java.util.NoSuchElementException - if there's no such handler of the specified type in this pipeline

java.lang.NullPointerException - if the specified handler type is null

removeFirst

ChannelHandler removeFirst()

Removes the first ChannelHandler in this pipeline.

Returns:

the removed handler

Throws:

java.util.NoSuchElementException - if this pipeline is empty

removeLast

ChannelHandler removeLast()

Removes the last ChannelHandler in this pipeline.

Returns:

the removed handler

Throws:

java.util.NoSuchElementException - if this pipeline is empty

replace

ChannelPipeline replace(ChannelHandler oldHandler,
                        java.lang.String newName,
                        ChannelHandler newHandler)

Replaces the specified ChannelHandler with a new handler in this pipeline.

Parameters:

oldHandler - the ChannelHandler to be replaced

newName - the name under which the replacement should be added

newHandler - the ChannelHandler which is used as replacement

Returns:

itself

Throws:

java.util.NoSuchElementException - if the specified old handler does not exist in this pipeline

java.lang.IllegalArgumentException - if a handler with the specified new name already exists in this pipeline, except for the handler to be replaced

java.lang.NullPointerException - if the specified old handler or new handler is null

replace

ChannelHandler replace(java.lang.String oldName,
                       java.lang.String newName,
                       ChannelHandler newHandler)

Replaces the ChannelHandler of the specified name with a new handler in this pipeline.

Parameters:

oldName - the name of the ChannelHandler to be replaced

newName - the name under which the replacement should be added

newHandler - the ChannelHandler which is used as replacement

Returns:

the removed handler

Throws:

java.util.NoSuchElementException - if the handler with the specified old name does not exist in this pipeline

java.lang.IllegalArgumentException - if a handler with the specified new name already exists in this pipeline, except for the handler to be replaced

java.lang.NullPointerException - if the specified old handler or new handler is null

replace

<T extends ChannelHandler> T replace(java.lang.Class<T> oldHandlerType,
                                     java.lang.String newName,
                                     ChannelHandler newHandler)

Replaces the ChannelHandler of the specified type with a new handler in this pipeline.

Parameters:

oldHandlerType - the type of the handler to be removed

newName - the name under which the replacement should be added

newHandler - the ChannelHandler which is used as replacement

Returns:

the removed handler

Throws:

java.util.NoSuchElementException - if the handler of the specified old handler type does not exist in this pipeline

java.lang.IllegalArgumentException - if a handler with the specified new name already exists in this pipeline, except for the handler to be replaced

java.lang.NullPointerException - if the specified old handler or new handler is null

first

ChannelHandler first()

Returns the first ChannelHandler in this pipeline.

Returns:

the first handler. null if this pipeline is empty.

firstContext

ChannelHandlerContext firstContext()

Returns the context of the first ChannelHandler in this pipeline.

Returns:

the context of the first handler. null if this pipeline is empty.

last

ChannelHandler last()

Returns the last ChannelHandler in this pipeline.

Returns:

the last handler. null if this pipeline is empty.

lastContext

ChannelHandlerContext lastContext()

Returns the context of the last ChannelHandler in this pipeline.

Returns:

the context of the last handler. null if this pipeline is empty.

get

ChannelHandler get(java.lang.String name)

Returns the ChannelHandler with the specified name in this pipeline.

Returns:

the handler with the specified name. null if there's no such handler in this pipeline.

get

<T extends ChannelHandler> T get(java.lang.Class<T> handlerType)

Returns the ChannelHandler of the specified type in this pipeline.

Returns:

the handler of the specified handler type. null if there's no such handler in this pipeline.

context

ChannelHandlerContext context(ChannelHandler handler)

Returns the context object of the specified ChannelHandler in this pipeline.

Returns:

the context object of the specified handler. null if there's no such handler in this pipeline.

context

ChannelHandlerContext context(java.lang.String name)

Returns the context object of the ChannelHandler with the specified name in this pipeline.

Returns:

the context object of the handler with the specified name. null if there's no such handler in this pipeline.

context

ChannelHandlerContext context(java.lang.Class<? extends ChannelHandler> handlerType)

Returns the context object of the ChannelHandler of the specified type in this pipeline.

Returns:

the context object of the handler of the specified type. null if there's no such handler in this pipeline.

channel

Channel channel()

Returns the Channel that this pipeline is attached to.

Returns:

the channel. null if this pipeline is not attached yet.

names

java.util.List<java.lang.String> names()

Returns the List of the handler names.

toMap

java.util.Map<java.lang.String,ChannelHandler> toMap()

Converts this pipeline into an ordered Map whose keys are handler names and whose values are handlers.

fireChannelRegistered

ChannelPipeline fireChannelRegistered()

Description copied from interface: ChannelInboundInvoker

A Channel was registered to its EventLoop. This will result in having the ChannelInboundHandler.channelRegistered(ChannelHandlerContext) method called of the next ChannelInboundHandler contained in the ChannelPipeline of the Channel.

Specified by:

fireChannelRegistered in interface ChannelInboundInvoker

fireChannelUnregistered

ChannelPipeline fireChannelUnregistered()

Description copied from interface: ChannelInboundInvoker

A Channel was unregistered from its EventLoop. This will result in having the ChannelInboundHandler.channelUnregistered(ChannelHandlerContext) method called of the next ChannelInboundHandler contained in the ChannelPipeline of the Channel.

Specified by:

fireChannelUnregistered in interface ChannelInboundInvoker

fireChannelActive

ChannelPipeline fireChannelActive()

Description copied from interface: ChannelInboundInvoker

A Channel is active now, which means it is connected. This will result in having the ChannelInboundHandler.channelActive(ChannelHandlerContext) method called of the next ChannelInboundHandler contained in the ChannelPipeline of the Channel.

Specified by:

fireChannelActive in interface ChannelInboundInvoker

fireChannelInactive

ChannelPipeline fireChannelInactive()

Description copied from interface: ChannelInboundInvoker

A Channel is inactive now, which means it is closed. This will result in having the ChannelInboundHandler.channelInactive(ChannelHandlerContext) method called of the next ChannelInboundHandler contained in the ChannelPipeline of the Channel.

Specified by:

fireChannelInactive in interface ChannelInboundInvoker

fireExceptionCaught

ChannelPipeline fireExceptionCaught(java.lang.Throwable cause)

Description copied from interface: ChannelInboundInvoker

A Channel received an Throwable in one of its inbound operations. This will result in having the ChannelInboundHandler.exceptionCaught(ChannelHandlerContext, Throwable) method called of the next ChannelInboundHandler contained in the ChannelPipeline of the Channel.

Specified by:

fireExceptionCaught in interface ChannelInboundInvoker

fireUserEventTriggered

ChannelPipeline fireUserEventTriggered(java.lang.Object event)

Description copied from interface: ChannelInboundInvoker

A Channel received an user defined event. This will result in having the ChannelInboundHandler.userEventTriggered(ChannelHandlerContext, Object) method called of the next ChannelInboundHandler contained in the ChannelPipeline of the Channel.

Specified by:

fireUserEventTriggered in interface ChannelInboundInvoker

fireChannelRead

ChannelPipeline fireChannelRead(java.lang.Object msg)

Description copied from interface: ChannelInboundInvoker

A Channel received a message. This will result in having the ChannelInboundHandler.channelRead(ChannelHandlerContext, Object) method called of the next ChannelInboundHandler contained in the ChannelPipeline of the Channel.

Specified by:

fireChannelRead in interface ChannelInboundInvoker

fireChannelReadComplete

ChannelPipeline fireChannelReadComplete()

Description copied from interface: ChannelInboundInvoker

Triggers an ChannelInboundHandler.channelReadComplete(ChannelHandlerContext) event to the next ChannelInboundHandler in the ChannelPipeline.

Specified by:

fireChannelReadComplete in interface ChannelInboundInvoker

fireChannelWritabilityChanged

ChannelPipeline fireChannelWritabilityChanged()

Description copied from interface: ChannelInboundInvoker

Triggers an ChannelInboundHandler.channelWritabilityChanged(ChannelHandlerContext) event to the next ChannelInboundHandler in the ChannelPipeline.

Specified by:

fireChannelWritabilityChanged in interface ChannelInboundInvoker

flush

ChannelPipeline flush()

Description copied from interface: ChannelOutboundInvoker

Request to flush all pending messages via this ChannelOutboundInvoker.

Specified by:

flush in interface ChannelOutboundInvoker

newPromise

default ChannelPromise newPromise()

Description copied from interface: ChannelOutboundInvoker

Return a new ChannelPromise.

Specified by:

newPromise in interface ChannelOutboundInvoker

newProgressivePromise

default ChannelProgressivePromise newProgressivePromise()

Description copied from interface: ChannelOutboundInvoker

Return an new ChannelProgressivePromise

Specified by:

newProgressivePromise in interface ChannelOutboundInvoker

newFailedFuture

default ChannelFuture newFailedFuture(java.lang.Throwable cause)

Description copied from interface: ChannelOutboundInvoker

Create a new ChannelFuture which is marked as failed already. So Future.isSuccess() will return false. All FutureListener added to it will be notified directly. Also every call of blocking methods will just return without blocking.

Specified by:

newFailedFuture in interface ChannelOutboundInvoker