DefaultChannelPipeline (Netty API Reference (4.1.130.Final))

JavaScript is disabled on your browser.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

io.netty.channel

Class DefaultChannelPipeline

java.lang.Object
- io.netty.channel.DefaultChannelPipeline

All Implemented Interfaces:

ChannelInboundInvoker, ChannelOutboundInvoker, ChannelPipeline, Iterable<Map.Entry<String,ChannelHandler>>
```
public class DefaultChannelPipeline
extends Object
implements ChannelPipeline 
```
The default ChannelPipeline implementation. It is usually created by a Channel implementation when the Channel is created.

Constructor Summary

Constructors
Modifier Constructor and Description

protected DefaultChannelPipeline (Channel channel)

Constructors
Modifier	Constructor and Description
`protected`	`DefaultChannelPipeline (Channel channel)`

Method Summary

All Methods
Modifier and Type	Method and Description
`ChannelPipeline`	`addAfter (EventExecutorGroup group, String baseName, String name, ChannelHandler handler)` Inserts a `ChannelHandler` after an existing handler of this pipeline.
`ChannelPipeline`	`addAfter (String baseName, String name, ChannelHandler handler)` Inserts a `ChannelHandler` after an existing handler of this pipeline.
`ChannelPipeline`	`addBefore (EventExecutorGroup group, String baseName, String name, ChannelHandler handler)` Inserts a `ChannelHandler` before an existing handler of this pipeline.
`ChannelPipeline`	`addBefore (String baseName, String name, ChannelHandler handler)` Inserts a `ChannelHandler` before an existing handler of this pipeline.
`ChannelPipeline`	`addFirst (ChannelHandler... handlers)` Inserts `ChannelHandler`s at the first position of this pipeline.
`ChannelPipeline`	`addFirst (ChannelHandler handler)`
`ChannelPipeline`	`addFirst (EventExecutorGroup executor, ChannelHandler... handlers)` Inserts `ChannelHandler`s at the first position of this pipeline.
`ChannelPipeline`	`addFirst (EventExecutorGroup group, String name, ChannelHandler handler)` Inserts a `ChannelHandler` at the first position of this pipeline.
`ChannelPipeline`	`addFirst (String name, ChannelHandler handler)` Inserts a `ChannelHandler` at the first position of this pipeline.
`ChannelPipeline`	`addLast (ChannelHandler... handlers)` Inserts `ChannelHandler`s at the last position of this pipeline.
`ChannelPipeline`	`addLast (ChannelHandler handler)`
`ChannelPipeline`	`addLast (EventExecutorGroup executor, ChannelHandler... handlers)` Inserts `ChannelHandler`s at the last position of this pipeline.
`ChannelPipeline`	`addLast (EventExecutorGroup group, String name, ChannelHandler handler)` Appends a `ChannelHandler` at the last position of this pipeline.
`ChannelPipeline`	`addLast (String name, ChannelHandler handler)` Appends a `ChannelHandler` at the last position of this pipeline.
`ChannelFuture`	`bind (SocketAddress localAddress)` Request to bind to the given `SocketAddress` and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`ChannelFuture`	`bind (SocketAddress localAddress, ChannelPromise promise)` Request to bind to the given `SocketAddress` and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`Channel`	`channel ()` Returns the `Channel` that this pipeline is attached to.
`ChannelFuture`	`close ()` Request to close the `Channel` and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`ChannelFuture`	`close (ChannelPromise promise)` Request to close the `Channel` and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`ChannelFuture`	`connect (SocketAddress remoteAddress)` Request to connect to the given `SocketAddress` and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`ChannelFuture`	`connect (SocketAddress remoteAddress, ChannelPromise promise)` Request to connect to the given `SocketAddress` and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`ChannelFuture`	`connect (SocketAddress remoteAddress, SocketAddress localAddress)` Request to connect to the given `SocketAddress` while bind to the localAddress and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`ChannelFuture`	`connect (SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise)` Request to connect to the given `SocketAddress` while bind to the localAddress and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`ChannelHandlerContext`	`context (ChannelHandler handler)` Returns the context object of the specified `ChannelHandler` in this pipeline.
`ChannelHandlerContext`	`context (Class<? extends ChannelHandler> handlerType)` Returns the context object of the `ChannelHandler` of the specified type in this pipeline.
`ChannelHandlerContext`	`context (String name)` Returns the context object of the `ChannelHandler` with the specified name in this pipeline.
`protected void`	`decrementPendingOutboundBytes (long size)`
`ChannelFuture`	`deregister ()` Request to deregister from the previous assigned `EventExecutor` and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`ChannelFuture`	`deregister (ChannelPromise promise)` Request to deregister from the previous assigned `EventExecutor` and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`ChannelFuture`	`disconnect ()` Request to disconnect from the remote peer and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`ChannelFuture`	`disconnect (ChannelPromise promise)` Request to disconnect from the remote peer and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`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 (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 (Throwable cause)` A `Channel` received an `Throwable` in one of its inbound operations.
`ChannelPipeline`	`fireUserEventTriggered (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 (Class<T> handlerType)` Returns the `ChannelHandler` of the specified type in this pipeline.
`ChannelHandler`	`get (String name)` Returns the `ChannelHandler` with the specified name in this pipeline.
`protected void`	`incrementPendingOutboundBytes (long size)`
`Iterator<Map.Entry<String,ChannelHandler>>`	`iterator ()`
`ChannelHandler`	`last ()` Returns the last `ChannelHandler` in this pipeline.
`ChannelHandlerContext`	`lastContext ()` Returns the context of the last `ChannelHandler` in this pipeline.
`List<String>`	`names ()` Returns the `List` of the handler names.
`ChannelFuture`	`newFailedFuture (Throwable cause)` Create a new `ChannelFuture` which is marked as failed already.
`ChannelProgressivePromise`	`newProgressivePromise ()` Return an new `ChannelProgressivePromise`
`ChannelPromise`	`newPromise ()` Return a new `ChannelPromise`.
`ChannelFuture`	`newSucceededFuture ()` Create a new `ChannelFuture` which is marked as succeeded already.
`protected void`	`onUnhandledChannelWritabilityChanged ()` Called once the `ChannelInboundHandler.channelWritabilityChanged(ChannelHandlerContext)` event hit the end of the `ChannelPipeline`.
`protected void`	`onUnhandledInboundChannelActive ()` Called once the `ChannelInboundHandler.channelActive(ChannelHandlerContext)`event hit the end of the `ChannelPipeline`.
`protected void`	`onUnhandledInboundChannelInactive ()` Called once the `ChannelInboundHandler.channelInactive(ChannelHandlerContext)` event hit the end of the `ChannelPipeline`.
`protected void`	`onUnhandledInboundChannelReadComplete ()` Called once the `ChannelInboundHandler.channelReadComplete(ChannelHandlerContext)` event hit the end of the `ChannelPipeline`.
`protected void`	`onUnhandledInboundException (Throwable cause)` Called once a `Throwable` hit the end of the `ChannelPipeline` without been handled by the user in `ChannelHandler.exceptionCaught(ChannelHandlerContext, Throwable)`.
`protected void`	`onUnhandledInboundMessage (ChannelHandlerContext ctx, Object msg)` Called once a message hit the end of the `ChannelPipeline` without been handled by the user in `ChannelInboundHandler.channelRead(ChannelHandlerContext, Object)`.
`protected void`	`onUnhandledInboundMessage (Object msg)` Called once a message hit the end of the `ChannelPipeline` without been handled by the user in `ChannelInboundHandler.channelRead(ChannelHandlerContext, Object)`.
`protected void`	`onUnhandledInboundUserEventTriggered (Object evt)` Called once an user event hit the end of the `ChannelPipeline` without been handled by the user in `ChannelInboundHandler.userEventTriggered(ChannelHandlerContext, Object)`.
`ChannelPipeline`	`read ()` Request to Read data from the `Channel` into the first inbound buffer, triggers an `ChannelInboundHandler.channelRead(ChannelHandlerContext, Object)` event if data was read, and triggers a `channelReadComplete` event so the handler can decide to continue reading.
`ChannelPipeline`	`remove (ChannelHandler handler)` Removes the specified `ChannelHandler` from this pipeline.
`<T extends ChannelHandler> T`	`remove (Class<T> handlerType)` Removes the `ChannelHandler` of the specified type from this pipeline.
`ChannelHandler`	`remove (String name)` Removes the `ChannelHandler` with the specified name from this pipeline.
`ChannelHandler`	`removeFirst ()` Removes the first `ChannelHandler` in this pipeline.
`<T extends ChannelHandler> T`	`removeIfExists (ChannelHandler handler)`
`<T extends ChannelHandler> T`	`removeIfExists (Class<T> handlerType)`
`<T extends ChannelHandler> T`	`removeIfExists (String name)`
`ChannelHandler`	`removeLast ()` Removes the last `ChannelHandler` in this pipeline.
`ChannelPipeline`	`replace (ChannelHandler oldHandler, String newName, ChannelHandler newHandler)` Replaces the specified `ChannelHandler` with a new handler in this pipeline.
`<T extends ChannelHandler> T`	`replace (Class<T> oldHandlerType, String newName, ChannelHandler newHandler)` Replaces the `ChannelHandler` of the specified type with a new handler in this pipeline.
`ChannelHandler`	`replace (String oldName, String newName, ChannelHandler newHandler)` Replaces the `ChannelHandler` of the specified name with a new handler in this pipeline.
`Map<String,ChannelHandler>`	`toMap ()` Converts this pipeline into an ordered `Map` whose keys are handler names and whose values are handlers.
`String`	`toString ()` Returns the `String` representation of this pipeline.
`ChannelPromise`	`voidPromise ()` Return a special ChannelPromise which can be reused for different operations.
`ChannelFuture`	`write (Object msg)` Request to write a message via this `ChannelHandlerContext` through the `ChannelPipeline`.
`ChannelFuture`	`write (Object msg, ChannelPromise promise)` Request to write a message via this `ChannelHandlerContext` through the `ChannelPipeline`.
`ChannelFuture`	`writeAndFlush (Object msg)` Shortcut for call `ChannelOutboundInvoker.write(Object)` and `ChannelOutboundInvoker.flush()`.
`ChannelFuture`	`writeAndFlush (Object msg, ChannelPromise promise)` Shortcut for call `ChannelOutboundInvoker.write(Object, ChannelPromise)` and `ChannelOutboundInvoker.flush()`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - DefaultChannelPipeline
```
protected DefaultChannelPipeline(Channel channel)
```
- Method Detail
  - channel
```
public final Channel channel()
```
    Description copied from interface: ChannelPipeline
    
    Returns the Channel that this pipeline is attached to.
    
    Specified by:
    
    channel in interface ChannelPipeline
    
    Returns:
    
    the channel. null if this pipeline is not attached yet.
  - addFirst
```
public final ChannelPipeline addFirst(String name,
 ChannelHandler handler)
```
    Description copied from interface: ChannelPipeline
    
    Inserts a ChannelHandler at the first position of this pipeline.
    
    Specified by:
    
    addFirst in interface ChannelPipeline
    
    Parameters:
    
    name - the name of the handler to insert first
    
    handler - the handler to insert first
  - addFirst
```
public final ChannelPipeline addFirst(EventExecutorGroup group,
 String name,
 ChannelHandler handler)
```
    Description copied from interface: ChannelPipeline
    
    Inserts a ChannelHandler at the first position of this pipeline.
    
    Specified by:
    
    addFirst in interface ChannelPipeline
    
    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
  - addLast
```
public final ChannelPipeline addLast(String name,
 ChannelHandler handler)
```
    Description copied from interface: ChannelPipeline
    
    Appends a ChannelHandler at the last position of this pipeline.
    
    Specified by:
    
    addLast in interface ChannelPipeline
    
    Parameters:
    
    name - the name of the handler to append
    
    handler - the handler to append
  - addLast
```
public final ChannelPipeline addLast(EventExecutorGroup group,
 String name,
 ChannelHandler handler)
```
    Description copied from interface: ChannelPipeline
    
    Appends a ChannelHandler at the last position of this pipeline.
    
    Specified by:
    
    addLast in interface ChannelPipeline
    
    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
  - addBefore
```
public final ChannelPipeline addBefore(String baseName,
 String name,
 ChannelHandler handler)
```
    Description copied from interface: ChannelPipeline
    
    Inserts a ChannelHandler before an existing handler of this pipeline.
    
    Specified by:
    
    addBefore in interface ChannelPipeline
    
    Parameters:
    
    baseName - the name of the existing handler
    
    name - the name of the handler to insert before
    
    handler - the handler to insert before
  - addBefore
```
public final ChannelPipeline addBefore(EventExecutorGroup group,
 String baseName,
 String name,
 ChannelHandler handler)
```
    Description copied from interface: ChannelPipeline
    
    Inserts a ChannelHandler before an existing handler of this pipeline.
    
    Specified by:
    
    addBefore in interface ChannelPipeline
    
    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
  - addAfter
```
public final ChannelPipeline addAfter(String baseName,
 String name,
 ChannelHandler handler)
```
    Description copied from interface: ChannelPipeline
    
    Inserts a ChannelHandler after an existing handler of this pipeline.
    
    Specified by:
    
    addAfter in interface ChannelPipeline
    
    Parameters:
    
    baseName - the name of the existing handler
    
    name - the name of the handler to insert after
    
    handler - the handler to insert after
  - addAfter
```
public final ChannelPipeline addAfter(EventExecutorGroup group,
 String baseName,
 String name,
 ChannelHandler handler)
```
    Description copied from interface: ChannelPipeline
    
    Inserts a ChannelHandler after an existing handler of this pipeline.
    
    Specified by:
    
    addAfter in interface ChannelPipeline
    
    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
  - addFirst
```
public final ChannelPipeline addFirst(ChannelHandler handler)
```
  - addFirst
```
public final ChannelPipeline addFirst(ChannelHandler... handlers)
```
    Description copied from interface: ChannelPipeline
    
    Inserts ChannelHandlers at the first position of this pipeline.
    
    Specified by:
    
    addFirst in interface ChannelPipeline
    
    Parameters:
    
    handlers - the handlers to insert first
  - addFirst
```
public final ChannelPipeline addFirst(EventExecutorGroup executor,
 ChannelHandler... handlers)
```
    Description copied from interface: ChannelPipeline
    
    Inserts ChannelHandlers at the first position of this pipeline.
    
    Specified by:
    
    addFirst in interface ChannelPipeline
    
    Parameters:
    
    executor - the EventExecutorGroup which will be used to execute the ChannelHandlers methods.
    
    handlers - the handlers to insert first
  - addLast
```
public final ChannelPipeline addLast(ChannelHandler handler)
```
  - addLast
```
public final ChannelPipeline addLast(ChannelHandler... handlers)
```
    Description copied from interface: ChannelPipeline
    
    Inserts ChannelHandlers at the last position of this pipeline.
    
    Specified by:
    
    addLast in interface ChannelPipeline
    
    Parameters:
    
    handlers - the handlers to insert last
  - addLast
```
public final ChannelPipeline addLast(EventExecutorGroup executor,
 ChannelHandler... handlers)
```
    Description copied from interface: ChannelPipeline
    
    Inserts ChannelHandlers at the last position of this pipeline.
    
    Specified by:
    
    addLast in interface ChannelPipeline
    
    Parameters:
    
    executor - the EventExecutorGroup which will be used to execute the ChannelHandlers methods.
    
    handlers - the handlers to insert last
  - remove
```
public final ChannelPipeline remove(ChannelHandler handler)
```
    Description copied from interface: ChannelPipeline
    
    Removes the specified ChannelHandler from this pipeline.
    
    Specified by:
    
    remove in interface ChannelPipeline
    
    Parameters:
    
    handler - the ChannelHandler to remove
  - remove
```
public final ChannelHandler remove(String name)
```
    Description copied from interface: ChannelPipeline
    
    Removes the ChannelHandler with the specified name from this pipeline.
    
    Specified by:
    
    remove in interface ChannelPipeline
    
    Parameters:
    
    name - the name under which the ChannelHandler was stored.
    
    Returns:
    
    the removed handler
  - remove
```
public final <T extends ChannelHandler> T remove(Class<T> handlerType)
```
    Description copied from interface: ChannelPipeline
    
    Removes the ChannelHandler of the specified type from this pipeline.
    
    Specified by:
    
    remove in interface ChannelPipeline
    
    Type Parameters:
    
    T - the type of the handler
    
    Parameters:
    
    handlerType - the type of the handler
    
    Returns:
    
    the removed handler
  - removeIfExists
```
public final <T extends ChannelHandler> T removeIfExists(String name)
```
  - removeIfExists
```
public final <T extends ChannelHandler> T removeIfExists(Class<T> handlerType)
```
  - removeIfExists
```
public final <T extends ChannelHandler> T removeIfExists(ChannelHandler handler)
```
  - removeFirst
```
public final ChannelHandler removeFirst()
```
    Description copied from interface: ChannelPipeline
    
    Removes the first ChannelHandler in this pipeline.
    
    Specified by:
    
    removeFirst in interface ChannelPipeline
    
    Returns:
    
    the removed handler
  - removeLast
```
public final ChannelHandler removeLast()
```
    Description copied from interface: ChannelPipeline
    
    Removes the last ChannelHandler in this pipeline.
    
    Specified by:
    
    removeLast in interface ChannelPipeline
    
    Returns:
    
    the removed handler
  - replace
```
public final ChannelPipeline replace(ChannelHandler oldHandler,
 String newName,
 ChannelHandler newHandler)
```
    Description copied from interface: ChannelPipeline
    
    Replaces the specified ChannelHandler with a new handler in this pipeline.
    
    Specified by:
    
    replace in interface ChannelPipeline
    
    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
  - replace
```
public final ChannelHandler replace(String oldName,
 String newName,
 ChannelHandler newHandler)
```
    Description copied from interface: ChannelPipeline
    
    Replaces the ChannelHandler of the specified name with a new handler in this pipeline.
    
    Specified by:
    
    replace in interface ChannelPipeline
    
    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
  - replace
```
public final <T extends ChannelHandler> T replace(Class<T> oldHandlerType,
 String newName,
 ChannelHandler newHandler)
```
    Description copied from interface: ChannelPipeline
    
    Replaces the ChannelHandler of the specified type with a new handler in this pipeline.
    
    Specified by:
    
    replace in interface ChannelPipeline
    
    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
  - first
```
public final ChannelHandler first()
```
    Description copied from interface: ChannelPipeline
    
    Returns the first ChannelHandler in this pipeline.
    
    Specified by:
    
    first in interface ChannelPipeline
    
    Returns:
    
    the first handler. null if this pipeline is empty.
  - firstContext
```
public final ChannelHandlerContext firstContext()
```
    Description copied from interface: ChannelPipeline
    
    Returns the context of the first ChannelHandler in this pipeline.
    
    Specified by:
    
    firstContext in interface ChannelPipeline
    
    Returns:
    
    the context of the first handler. null if this pipeline is empty.
  - last
```
public final ChannelHandler last()
```
    Description copied from interface: ChannelPipeline
    
    Returns the last ChannelHandler in this pipeline.
    
    Specified by:
    
    last in interface ChannelPipeline
    
    Returns:
    
    the last handler. null if this pipeline is empty.
  - lastContext
```
public final ChannelHandlerContext lastContext()
```
    Description copied from interface: ChannelPipeline
    
    Returns the context of the last ChannelHandler in this pipeline.
    
    Specified by:
    
    lastContext in interface ChannelPipeline
    
    Returns:
    
    the context of the last handler. null if this pipeline is empty.
  - get
```
public final ChannelHandler get(String name)
```
    Description copied from interface: ChannelPipeline
    
    Returns the ChannelHandler with the specified name in this pipeline.
    
    Specified by:
    
    get in interface ChannelPipeline
    
    Returns:
    
    the handler with the specified name. null if there's no such handler in this pipeline.
  - get
```
public final <T extends ChannelHandler> T get(Class<T> handlerType)
```
    Description copied from interface: ChannelPipeline
    
    Returns the ChannelHandler of the specified type in this pipeline.
    
    Specified by:
    
    get in interface ChannelPipeline
    
    Returns:
    
    the handler of the specified handler type. null if there's no such handler in this pipeline.
  - context
```
public final ChannelHandlerContext context(String name)
```
    Description copied from interface: ChannelPipeline
    
    Returns the context object of the ChannelHandler with the specified name in this pipeline.
    
    Specified by:
    
    context in interface ChannelPipeline
    
    Returns:
    
    the context object of the handler with the specified name. null if there's no such handler in this pipeline.
  - context
```
public final ChannelHandlerContext context(ChannelHandler handler)
```
    Description copied from interface: ChannelPipeline
    
    Returns the context object of the specified ChannelHandler in this pipeline.
    
    Specified by:
    
    context in interface ChannelPipeline
    
    Returns:
    
    the context object of the specified handler. null if there's no such handler in this pipeline.
  - context
```
public final ChannelHandlerContext context(Class<? extends ChannelHandler> handlerType)
```
    Description copied from interface: ChannelPipeline
    
    Returns the context object of the ChannelHandler of the specified type in this pipeline.
    
    Specified by:
    
    context in interface ChannelPipeline
    
    Returns:
    
    the context object of the handler of the specified type. null if there's no such handler in this pipeline.
  - names
```
public final List<String> names()
```
    Description copied from interface: ChannelPipeline
    
    Returns the List of the handler names.
    
    Specified by:
    
    names in interface ChannelPipeline
  - toMap
```
public final Map<String,ChannelHandler> toMap()
```
    Description copied from interface: ChannelPipeline
    
    Converts this pipeline into an ordered Map whose keys are handler names and whose values are handlers.
    
    Specified by:
    
    toMap in interface ChannelPipeline
  - iterator
```
public final Iterator<Map.Entry<String,ChannelHandler>> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Map.Entry<String,ChannelHandler>>
  - toString
```
public final String toString()
```
    Returns the String representation of this pipeline.
    
    Overrides:
    
    toString in class Object
  - fireChannelRegistered
```
public final 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
    
    Specified by:
    
    fireChannelRegistered in interface ChannelPipeline
  - fireChannelUnregistered
```
public final 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
    
    Specified by:
    
    fireChannelUnregistered in interface ChannelPipeline
  - fireChannelActive
```
public final 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
    
    Specified by:
    
    fireChannelActive in interface ChannelPipeline
  - fireChannelInactive
```
public final 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
    
    Specified by:
    
    fireChannelInactive in interface ChannelPipeline
  - fireExceptionCaught
```
public final ChannelPipeline fireExceptionCaught(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
    
    Specified by:
    
    fireExceptionCaught in interface ChannelPipeline
  - fireUserEventTriggered
```
public final ChannelPipeline fireUserEventTriggered(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
    
    Specified by:
    
    fireUserEventTriggered in interface ChannelPipeline
  - fireChannelRead
```
public final ChannelPipeline fireChannelRead(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
    
    Specified by:
    
    fireChannelRead in interface ChannelPipeline
  - fireChannelReadComplete
```
public final 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
    
    Specified by:
    
    fireChannelReadComplete in interface ChannelPipeline
  - fireChannelWritabilityChanged
```
public final 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
    
    Specified by:
    
    fireChannelWritabilityChanged in interface ChannelPipeline
  - bind
```
public final ChannelFuture bind(SocketAddress localAddress)
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to bind to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
    This will result in having the ChannelOutboundHandler.bind(ChannelHandlerContext, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    bind in interface ChannelOutboundInvoker
  - connect
```
public final ChannelFuture connect(SocketAddress remoteAddress)
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to connect to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
    If the connection fails because of a connection timeout, the ChannelFuture will get failed with a ConnectTimeoutException. If it fails because of connection refused a ConnectException will be used.
    This will result in having the ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    connect in interface ChannelOutboundInvoker
  - connect
```
public final ChannelFuture connect(SocketAddress remoteAddress,
 SocketAddress localAddress)
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to connect to the given SocketAddress while bind to the localAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
    This will result in having the ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    connect in interface ChannelOutboundInvoker
  - disconnect
```
public final ChannelFuture disconnect()
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to disconnect from the remote peer and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
    This will result in having the ChannelOutboundHandler.disconnect(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    disconnect in interface ChannelOutboundInvoker
  - close
```
public final ChannelFuture close()
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to close the Channel and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. After it is closed it is not possible to reuse it again.
    This will result in having the ChannelOutboundHandler.close(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    close in interface ChannelOutboundInvoker
  - deregister
```
public final ChannelFuture deregister()
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to deregister from the previous assigned EventExecutor and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
    This will result in having the ChannelOutboundHandler.deregister(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    deregister in interface ChannelOutboundInvoker
  - flush
```
public final ChannelPipeline flush()
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to flush all pending messages via this ChannelOutboundInvoker.
    
    Specified by:
    
    flush in interface ChannelOutboundInvoker
    
    Specified by:
    
    flush in interface ChannelPipeline
  - bind
```
public final ChannelFuture bind(SocketAddress localAddress,
 ChannelPromise promise)
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to bind to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. The given ChannelPromise will be notified.
    This will result in having the ChannelOutboundHandler.bind(ChannelHandlerContext, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    bind in interface ChannelOutboundInvoker
  - connect
```
public final ChannelFuture connect(SocketAddress remoteAddress,
 ChannelPromise promise)
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to connect to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. The given ChannelFuture will be notified.
    If the connection fails because of a connection timeout, the ChannelFuture will get failed with a ConnectTimeoutException. If it fails because of connection refused a ConnectException will be used.
    This will result in having the ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    connect in interface ChannelOutboundInvoker
  - connect
```
public final ChannelFuture connect(SocketAddress remoteAddress,
 SocketAddress localAddress,
 ChannelPromise promise)
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to connect to the given SocketAddress while bind to the localAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. The given ChannelPromise will be notified and also returned.
    This will result in having the ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    connect in interface ChannelOutboundInvoker
  - disconnect
```
public final ChannelFuture disconnect(ChannelPromise promise)
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to disconnect from the remote peer and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. The given ChannelPromise will be notified.
    This will result in having the ChannelOutboundHandler.disconnect(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    disconnect in interface ChannelOutboundInvoker
  - close
```
public final ChannelFuture close(ChannelPromise promise)
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to close the Channel and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. After it is closed it is not possible to reuse it again. The given ChannelPromise will be notified.
    This will result in having the ChannelOutboundHandler.close(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    close in interface ChannelOutboundInvoker
  - deregister
```
public final ChannelFuture deregister(ChannelPromise promise)
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to deregister from the previous assigned EventExecutor and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. The given ChannelPromise will be notified.
    This will result in having the ChannelOutboundHandler.deregister(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    deregister in interface ChannelOutboundInvoker
  - read
```
public final ChannelPipeline read()
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to Read data from the Channel into the first inbound buffer, triggers an ChannelInboundHandler.channelRead(ChannelHandlerContext, Object) event if data was read, and triggers a channelReadComplete event so the handler can decide to continue reading. If there's a pending read operation already, this method does nothing.
    This will result in having the ChannelOutboundHandler.read(ChannelHandlerContext) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    read in interface ChannelOutboundInvoker
  - write
```
public final ChannelFuture write(Object msg)
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to write a message via this ChannelHandlerContext through the ChannelPipeline. This method will not request to actual flush, so be sure to call ChannelOutboundInvoker.flush() once you want to request to flush all pending data to the actual transport.
    
    Specified by:
    
    write in interface ChannelOutboundInvoker
  - write
```
public final ChannelFuture write(Object msg,
 ChannelPromise promise)
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to write a message via this ChannelHandlerContext through the ChannelPipeline. This method will not request to actual flush, so be sure to call ChannelOutboundInvoker.flush() once you want to request to flush all pending data to the actual transport.
    
    Specified by:
    
    write in interface ChannelOutboundInvoker
  - writeAndFlush
```
public final ChannelFuture writeAndFlush(Object msg,
 ChannelPromise promise)
```
    Description copied from interface: ChannelOutboundInvoker
    
    Shortcut for call ChannelOutboundInvoker.write(Object, ChannelPromise) and ChannelOutboundInvoker.flush().
    
    Specified by:
    
    writeAndFlush in interface ChannelOutboundInvoker
  - writeAndFlush
```
public final ChannelFuture writeAndFlush(Object msg)
```
    Description copied from interface: ChannelOutboundInvoker
    
    Shortcut for call ChannelOutboundInvoker.write(Object) and ChannelOutboundInvoker.flush().
    
    Specified by:
    
    writeAndFlush in interface ChannelOutboundInvoker
  - newPromise
```
public final ChannelPromise newPromise()
```
    Description copied from interface: ChannelOutboundInvoker
    
    Return a new ChannelPromise.
    
    Specified by:
    
    newPromise in interface ChannelOutboundInvoker
  - newProgressivePromise
```
public final ChannelProgressivePromise newProgressivePromise()
```
    Description copied from interface: ChannelOutboundInvoker
    
    Return an new ChannelProgressivePromise
    
    Specified by:
    
    newProgressivePromise in interface ChannelOutboundInvoker
  - newSucceededFuture
```
public final ChannelFuture newSucceededFuture()
```
    Description copied from interface: ChannelOutboundInvoker
    
    Create a new ChannelFuture which is marked as succeeded already. So Future.isSuccess() will return true. All FutureListener added to it will be notified directly. Also every call of blocking methods will just return without blocking.
    
    Specified by:
    
    newSucceededFuture in interface ChannelOutboundInvoker
  - newFailedFuture
```
public final ChannelFuture newFailedFuture(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
  - voidPromise
```
public final ChannelPromise voidPromise()
```
    Description copied from interface: ChannelOutboundInvoker
    
    Return a special ChannelPromise which can be reused for different operations.
    It's only supported to use it for ChannelOutboundInvoker.write(Object, ChannelPromise).
    
    Be aware that the returned ChannelPromise will not support most operations and should only be used if you want to save an object allocation for every write operation. You will not be able to detect if the operation was complete, only if it failed as the implementation will call ChannelPipeline.fireExceptionCaught(Throwable) in this case.
    Be aware this is an expert feature and should be used with care!
    
    Specified by:
    
    voidPromise in interface ChannelOutboundInvoker
  - onUnhandledInboundException
```
protected void onUnhandledInboundException(Throwable cause)
```
    Called once a Throwable hit the end of the ChannelPipeline without been handled by the user in ChannelHandler.exceptionCaught(ChannelHandlerContext, Throwable).
  - onUnhandledInboundChannelActive
```
protected void onUnhandledInboundChannelActive()
```
    Called once the ChannelInboundHandler.channelActive(ChannelHandlerContext)event hit the end of the ChannelPipeline.
  - onUnhandledInboundChannelInactive
```
protected void onUnhandledInboundChannelInactive()
```
    Called once the ChannelInboundHandler.channelInactive(ChannelHandlerContext) event hit the end of the ChannelPipeline.
  - onUnhandledInboundMessage
```
protected void onUnhandledInboundMessage(Object msg)
```
    Called once a message hit the end of the ChannelPipeline without been handled by the user in ChannelInboundHandler.channelRead(ChannelHandlerContext, Object). This method is responsible to call ReferenceCountUtil.release(Object) on the given msg at some point.
  - onUnhandledInboundMessage
```
protected void onUnhandledInboundMessage(ChannelHandlerContext ctx,
 Object msg)
```
    Called once a message hit the end of the ChannelPipeline without been handled by the user in ChannelInboundHandler.channelRead(ChannelHandlerContext, Object). This method is responsible to call ReferenceCountUtil.release(Object) on the given msg at some point.
  - onUnhandledInboundChannelReadComplete
```
protected void onUnhandledInboundChannelReadComplete()
```
    Called once the ChannelInboundHandler.channelReadComplete(ChannelHandlerContext) event hit the end of the ChannelPipeline.
  - onUnhandledInboundUserEventTriggered
```
protected void onUnhandledInboundUserEventTriggered(Object evt)
```
    Called once an user event hit the end of the ChannelPipeline without been handled by the user in ChannelInboundHandler.userEventTriggered(ChannelHandlerContext, Object). This method is responsible to call ReferenceCountUtil.release(Object) on the given event at some point.
  - onUnhandledChannelWritabilityChanged
```
protected void onUnhandledChannelWritabilityChanged()
```
    Called once the ChannelInboundHandler.channelWritabilityChanged(ChannelHandlerContext) event hit the end of the ChannelPipeline.
  - incrementPendingOutboundBytes
```
protected void incrementPendingOutboundBytes(long size)
```
  - decrementPendingOutboundBytes
```
protected void decrementPendingOutboundBytes(long size)
```

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Class DefaultChannelPipeline

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

DefaultChannelPipeline

Method Detail

channel

addFirst

addFirst

addLast

addLast

addBefore

addBefore

addAfter

addAfter

addFirst

addFirst

addFirst

addLast

addLast

addLast

remove

remove

remove

removeIfExists

removeIfExists

removeIfExists

removeFirst

removeLast

replace

replace

replace

first

firstContext

last

lastContext

get

get

context

context

context

names

toMap

iterator

toString

fireChannelRegistered

fireChannelUnregistered

fireChannelActive

fireChannelInactive

fireExceptionCaught

fireUserEventTriggered

fireChannelRead

fireChannelReadComplete

fireChannelWritabilityChanged

bind

connect

connect

disconnect

close

deregister

flush

bind

connect

connect

disconnect

close

deregister

read

write

write

writeAndFlush

writeAndFlush

newPromise

newProgressivePromise

newSucceededFuture

newFailedFuture

voidPromise

onUnhandledInboundException