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

All Implemented Interfaces:

ChannelInboundInvoker, ChannelOutboundInvoker, ChannelPipeline, FuturePromiseFactory, Iterable<Map.Entry<String,ChannelHandler>>

Direct Known Subclasses:

AbstractChannel.DefaultAbstractChannelPipeline
```
public abstract 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 Description

protected DefaultChannelPipeline(Channel channel)

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`ChannelPipeline`	`addAfter(String baseName, String name, ChannelHandler handler)`	Inserts a `ChannelHandler` after 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 handler)`
`ChannelPipeline`	`addFirst(ChannelHandler... handlers)`	Inserts `ChannelHandler`s 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 handler)`
`ChannelPipeline`	`addLast(ChannelHandler... handlers)`	Inserts `ChannelHandler`s at the last position of this pipeline.
`ChannelPipeline`	`addLast(String name, ChannelHandler handler)`	Appends a `ChannelHandler` at the last position of this pipeline.
`Future<Void>`	`bind(SocketAddress localAddress)`	Request to bind to the given `SocketAddress` and notify the `Future` once the operation completes, either because the operation was successful or because of an error.
`protected abstract void`	`bindTransport(SocketAddress localAddress, Promise<Void> promise)`	Bind the `SocketAddress` to the transport and notify the `Promise` once the operation was completed.
`Channel`	`channel()`	Returns the `Channel` that this pipeline is attached to.
`Future<Void>`	`close()`	Request to close the `Channel` and notify the `Future` once the operation completes, either because the operation was successful or because of an error.
`protected abstract void`	`closeTransport(Promise<Void> promise)`	Close the transport and notify the `Promise` once the operation was completed.
`Future<Void>`	`connect(SocketAddress remoteAddress)`	Request to connect to the given `SocketAddress` and notify the `Future` once the operation completes, either because the operation was successful or because of an error.
`Future<Void>`	`connect(SocketAddress remoteAddress, SocketAddress localAddress)`	Request to connect to the given `SocketAddress` while bind to the localAddress and notify the `Future` once the operation completes, either because the operation was successful or because of an error.
`protected abstract void`	`connectTransport(SocketAddress remoteAddress, SocketAddress localAddress, Promise<Void> promise)`	Connect the transport with the given remote `SocketAddress`.
`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.
`Future<Void>`	`deregister()`	Request to deregister from the previous assigned `EventExecutor` and notify the `Future` once the operation completes, either because the operation was successful or because of an error.
`protected abstract void`	`deregisterTransport(Promise<Void> promise)`	Deregister the transport of the `EventLoop` and notify the `Promise` once the operation was completed.
`Future<Void>`	`disconnect()`	Request to disconnect from the remote peer and notify the `Future` once the operation completes, either because the operation was successful or because of an error.
`protected abstract void`	`disconnectTransport(Promise<Void> promise)`	Disconnect the transport and notify the `Promise` once the operation was completed.
`EventExecutor`	`executor()`	Returns the `EventExecutor` that is used to execute the operations of this `ChannelOutboundInvoker`.
`ChannelPipeline`	`fireChannelActive()`	A `Channel` is active now, which means it is connected.
`ChannelPipeline`	`fireChannelExceptionCaught(Throwable cause)`	A `Channel` received an `Throwable` in one of its inbound operations.
`ChannelPipeline`	`fireChannelInactive()`	A `Channel` is inactive now, which means it is closed.
`ChannelPipeline`	`fireChannelInboundEvent(Object event)`	A `Channel` received a custom defined inbound event.
`ChannelPipeline`	`fireChannelRead(Object msg)`	A `Channel` received a message.
`ChannelPipeline`	`fireChannelReadComplete()`	Triggers an `ChannelHandler.channelReadComplete(ChannelHandlerContext)` event to the next `ChannelHandler` in the `ChannelPipeline`.
`ChannelPipeline`	`fireChannelRegistered()`	A `Channel` was registered to its `EventLoop`.
`ChannelPipeline`	`fireChannelShutdown(ChannelShutdownDirection direction)`	A `Channel` was shutdown in a specific direction.
`ChannelPipeline`	`fireChannelUnregistered()`	A `Channel` was unregistered from its `EventLoop`.
`ChannelPipeline`	`fireChannelWritabilityChanged()`	Triggers an `ChannelHandler.channelWritabilityChanged(ChannelHandlerContext)` event to the next `ChannelHandler` in the `ChannelPipeline`.
`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.
`protected abstract void`	`flushTransport()`	Flush out all (previous) scheduled write operations, scheduled via `writeTransport(Object, Promise)`.
`<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.
`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.
`<V> Future<V>`	`newFailedFuture(Throwable cause)`	Create a new `Future` which is marked as failed already.
`<V> Promise<V>`	`newPromise()`	Return a new `Promise`.
`Future<Void>`	`newSucceededFuture()`	Create a new `Future` which is marked as succeeded already.
`<V> Future<V>`	`newSucceededFuture(V value)`	Create a new `Future` which is marked as succeeded already.
`protected void`	`onUnhandledChannelInboundEvent(Object evt)`	Called once an user event hit the end of the `ChannelPipeline` without been handled by the user in `ChannelHandler.channelInboundEvent(ChannelHandlerContext, Object)`.
`protected void`	`onUnhandledChannelWritabilityChanged()`	Called once the `ChannelHandler.channelWritabilityChanged(ChannelHandlerContext)` event hit the end of the `ChannelPipeline`.
`protected void`	`onUnhandledInboundChannelActive()`	Called once the `ChannelHandler.channelActive(ChannelHandlerContext)`event hit the end of the `ChannelPipeline`.
`protected void`	`onUnhandledInboundChannelInactive()`	Called once the `ChannelHandler.channelInactive(ChannelHandlerContext)` event hit the end of the `ChannelPipeline`.
`protected void`	`onUnhandledInboundChannelReadComplete()`	Called once the `ChannelHandler.channelReadComplete(ChannelHandlerContext)` event hit the end of the `ChannelPipeline`.
`protected void`	`onUnhandledInboundChannelShutdown(ChannelShutdownDirection direction)`	Called once the `ChannelHandler.channelShutdown(ChannelHandlerContext, ChannelShutdownDirection)` 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.channelExceptionCaught(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 `ChannelHandler.channelRead(ChannelHandlerContext, Object)`.
`long`	`pendingOutboundBytes()`	The number of the outbound bytes that are buffered / queued in this `ChannelPipeline`.
`protected abstract void`	`pendingOutboundBytesUpdated(long pendingOutboundBytes)`	Called once the `pendingOutboundBytes()` were changed.
`ChannelPipeline`	`read()`	Request to Read data from the `Channel` into the first inbound buffer, triggers an `ChannelHandler.channelRead(ChannelHandlerContext, Object)` event if data was read, and triggers a `channelReadComplete` event so the handler can decide to continue reading.
`protected abstract void`	`readTransport()`	Schedules a read operation on the transport that fills the inbound buffer of the first `ChannelHandler` in the `ChannelPipeline`.
`Future<Void>`	`register()`	Request to register on the `EventExecutor` for I/O processing.
`protected abstract void`	`registerTransport(Promise<Void> promise)`	Register the transport and notify the `Promise` once the operation was completed.
`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)`	Removes the specified `ChannelHandler` from this pipeline if it exists
`<T extends ChannelHandler> T`	`removeIfExists(Class<T> handlerType)`	Removes the `ChannelHandler` of the specified type from this pipeline if it exists.
`<T extends ChannelHandler> T`	`removeIfExists(String name)`	Removes the `ChannelHandler` with the specified name from this pipeline if it exists.
`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.
`Future<Void>`	`sendOutboundEvent(Object event)`	Send a custom outbound event via this `ChannelOutboundInvoker` through the `ChannelPipeline`.
`protected abstract void`	`sendOutboundEventTransport(Object event, Promise<Void> promise)`	Send a custom outbound event on the transport.
`Future<Void>`	`shutdown(ChannelShutdownDirection direction)`	Request shutdown one direction of the `Channel` and notify the `Future` once the operation completes, either because the operation was successful or because of an error.
`protected abstract void`	`shutdownTransport(ChannelShutdownDirection direction, Promise<Void> promise)`	Shutdown the given direction of the transport and notify the `Promise` once the operation was completed.
`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.
`protected abstract EventExecutor`	`transportExecutor()`	Returns the `EventExecutor` that is used for all the abstract transport operations.
`Future<Void>`	`write(Object msg)`	Request to write a message via this `ChannelHandlerContext` through the `ChannelPipeline`.
`Future<Void>`	`writeAndFlush(Object msg)`	Shortcut for call `ChannelOutboundInvoker.write(Object)` and `ChannelOutboundInvoker.flush()`.
`protected abstract void`	`writeTransport(Object msg, Promise<Void> promise)`	Schedules a write operation on the transport.

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

Methods inherited from interface io.netty5.channel.ChannelPipeline
isEmpty

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.
  - executor
```
public final EventExecutor executor()
```
    Description copied from interface: ChannelOutboundInvoker
    
    Returns the EventExecutor that is used to execute the operations of this ChannelOutboundInvoker.
    
    Specified by:
    
    executor in interface ChannelOutboundInvoker
    
    Returns:
    
    the executor.
  - 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
  - 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
  - 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
  - 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
  - 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. null handlers will be skipped.
    
    Specified by:
    
    addFirst in interface ChannelPipeline
    
    Parameters:
    
    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. null handlers will be skipped.
    
    Specified by:
    
    addLast in interface ChannelPipeline
    
    Parameters:
    
    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)
```
    Description copied from interface: ChannelPipeline
    
    Removes the ChannelHandler with the specified name from this pipeline if it exists.
    
    Specified by:
    
    removeIfExists in interface ChannelPipeline
    
    Parameters:
    
    name - the name under which the ChannelHandler was stored.
    
    Returns:
    
    the removed handler
  - removeIfExists
```
public final <T extends ChannelHandler> T removeIfExists(Class<T> handlerType)
```
    Description copied from interface: ChannelPipeline
    
    Removes the ChannelHandler of the specified type from this pipeline if it exists.
    
    Specified by:
    
    removeIfExists in interface ChannelPipeline
    
    Type Parameters:
    
    T - the type of the handler
    
    Parameters:
    
    handlerType - the type of the handler
    
    Returns:
    
    the removed handler or null if it didn't exist.
  - removeIfExists
```
public final <T extends ChannelHandler> T removeIfExists(ChannelHandler handler)
```
    Description copied from interface: ChannelPipeline
    
    Removes the specified ChannelHandler from this pipeline if it exists
    
    Specified by:
    
    removeIfExists in interface ChannelPipeline
    
    Parameters:
    
    handler - the ChannelHandler to remove
    
    Returns:
    
    the removed handler or null if it didn't exist.
  - 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
  - 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
  - toString
```
public final String toString()
```
    Returns the String representation of this pipeline.
    
    Overrides:
    
    toString in class Object
  - removeFirst
```
public 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 ChannelHandler removeLast()
```
    Description copied from interface: ChannelPipeline
    
    Removes the last ChannelHandler in this pipeline.
    
    Specified by:
    
    removeLast in interface ChannelPipeline
    
    Returns:
    
    the removed handler
  - first
```
public 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 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 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 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.
  - toMap
```
public 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 Iterator<Map.Entry<String,ChannelHandler>> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Map.Entry<String,ChannelHandler>>
  - fireChannelRegistered
```
public final ChannelPipeline fireChannelRegistered()
```
    Description copied from interface: ChannelInboundInvoker
    
    A Channel was registered to its EventLoop. This will result in having the ChannelHandler.channelRegistered(ChannelHandlerContext) method called of the next ChannelHandler 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 ChannelHandler.channelUnregistered(ChannelHandlerContext) method called of the next ChannelHandler 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 ChannelHandler.channelActive(ChannelHandlerContext) method called of the next ChannelHandler 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 ChannelHandler.channelInactive(ChannelHandlerContext) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    fireChannelInactive in interface ChannelInboundInvoker
    
    Specified by:
    
    fireChannelInactive in interface ChannelPipeline
  - fireChannelShutdown
```
public final ChannelPipeline fireChannelShutdown(ChannelShutdownDirection direction)
```
    Description copied from interface: ChannelInboundInvoker
    
    A Channel was shutdown in a specific direction. This will result in having the ChannelHandler.channelShutdown(ChannelHandlerContext, ChannelShutdownDirection) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    fireChannelShutdown in interface ChannelInboundInvoker
    
    Specified by:
    
    fireChannelShutdown in interface ChannelPipeline
  - fireChannelExceptionCaught
```
public final ChannelPipeline fireChannelExceptionCaught(Throwable cause)
```
    Description copied from interface: ChannelInboundInvoker
    
    A Channel received an Throwable in one of its inbound operations. This will result in having the ChannelHandler.channelExceptionCaught(ChannelHandlerContext, Throwable) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    fireChannelExceptionCaught in interface ChannelInboundInvoker
    
    Specified by:
    
    fireChannelExceptionCaught in interface ChannelPipeline
  - fireChannelInboundEvent
```
public final ChannelPipeline fireChannelInboundEvent(Object event)
```
    Description copied from interface: ChannelInboundInvoker
    
    A Channel received a custom defined inbound event. This will result in having the ChannelHandler.channelInboundEvent(ChannelHandlerContext, Object) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    fireChannelInboundEvent in interface ChannelInboundInvoker
    
    Specified by:
    
    fireChannelInboundEvent 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 ChannelHandler.channelRead(ChannelHandlerContext, Object) method called of the next ChannelHandler 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 ChannelHandler.channelReadComplete(ChannelHandlerContext) event to the next ChannelHandler 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 ChannelHandler.channelWritabilityChanged(ChannelHandlerContext) event to the next ChannelHandler in the ChannelPipeline.
    
    Specified by:
    
    fireChannelWritabilityChanged in interface ChannelInboundInvoker
    
    Specified by:
    
    fireChannelWritabilityChanged in interface ChannelPipeline
  - bind
```
public final Future<Void> bind(SocketAddress localAddress)
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to bind to the given SocketAddress and notify the Future once the operation completes, either because the operation was successful or because of an error.
    This will result in having the ChannelHandler.bind(ChannelHandlerContext, SocketAddress) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    bind in interface ChannelOutboundInvoker
  - connect
```
public final Future<Void> connect(SocketAddress remoteAddress)
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to connect to the given SocketAddress and notify the Future 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 Future will get failed with a ConnectTimeoutException. If it fails because of connection refused a ConnectException will be used.
    This will result in having the ChannelHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    connect in interface ChannelOutboundInvoker
  - connect
```
public final Future<Void> 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 Future once the operation completes, either because the operation was successful or because of an error.
    This will result in having the ChannelHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    connect in interface ChannelOutboundInvoker
  - disconnect
```
public final Future<Void> disconnect()
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to disconnect from the remote peer and notify the Future once the operation completes, either because the operation was successful or because of an error.
    This will result in having the ChannelHandler.disconnect(ChannelHandlerContext) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    disconnect in interface ChannelOutboundInvoker
  - close
```
public final Future<Void> close()
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to close the Channel and notify the Future 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 ChannelHandler.close(ChannelHandlerContext) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    close in interface ChannelOutboundInvoker
  - shutdown
```
public Future<Void> shutdown(ChannelShutdownDirection direction)
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request shutdown one direction of the Channel and notify the Future once the operation completes, either because the operation was successful or because of an error.
    When completed, the channel will either not produce any inbound data anymore, or it will not be possible to write data anymore, depending on the given ChannelShutdownDirection.
    Depending on the transport implementation shutting down the ChannelShutdownDirection.Outbound or ChannelShutdownDirection.Inbound might also result in data transferred over the network. Like for example in case of TCP shutting down the ChannelShutdownDirection.Outbound will result in a FIN that is transmitted to the remote peer that will as a result shutdown ChannelShutdownDirection.Inbound.
    This will result in having the ChannelHandler.shutdown(ChannelHandlerContext, ChannelShutdownDirection). method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    shutdown in interface ChannelOutboundInvoker
  - register
```
public final Future<Void> register()
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to register on the EventExecutor for I/O processing. Future once the operation completes, either because the operation was successful or because of an error.
    This will result in having the ChannelHandler.register(ChannelHandlerContext) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    register in interface ChannelOutboundInvoker
  - deregister
```
public final Future<Void> deregister()
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to deregister from the previous assigned EventExecutor and notify the Future once the operation completes, either because the operation was successful or because of an error.
    This will result in having the ChannelHandler.deregister(ChannelHandlerContext) method called of the next ChannelHandler 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
  - read
```
public final ChannelPipeline read()
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to Read data from the Channel into the first inbound buffer, triggers an ChannelHandler.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 ChannelHandler.read(ChannelHandlerContext) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    read in interface ChannelOutboundInvoker
  - write
```
public final Future<Void> 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
  - writeAndFlush
```
public final Future<Void> writeAndFlush(Object msg)
```
    Description copied from interface: ChannelOutboundInvoker
    
    Shortcut for call ChannelOutboundInvoker.write(Object) and ChannelOutboundInvoker.flush().
    
    Specified by:
    
    writeAndFlush in interface ChannelOutboundInvoker
  - sendOutboundEvent
```
public final Future<Void> sendOutboundEvent(Object event)
```
    Description copied from interface: ChannelOutboundInvoker
    
    Send a custom outbound event via this ChannelOutboundInvoker through the ChannelPipeline.
    This will result in having the ChannelHandler.sendOutboundEvent(ChannelHandlerContext, Object) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    sendOutboundEvent in interface ChannelOutboundInvoker
  - newPromise
```
public final <V> Promise<V> newPromise()
```
    Description copied from interface: FuturePromiseFactory
    
    Return a new Promise.
    
    Specified by:
    
    newPromise in interface ChannelOutboundInvoker
    
    Specified by:
    
    newPromise in interface FuturePromiseFactory
  - newSucceededFuture
```
public final Future<Void> newSucceededFuture()
```
    Description copied from interface: FuturePromiseFactory
    
    Create a new Future which is marked as succeeded already. So AsynchronousResult.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
    
    Specified by:
    
    newSucceededFuture in interface FuturePromiseFactory
  - newSucceededFuture
```
public final <V> Future<V> newSucceededFuture(V value)
```
    Description copied from interface: FuturePromiseFactory
    
    Create a new Future which is marked as succeeded already. So AsynchronousResult.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
    
    Specified by:
    
    newSucceededFuture in interface FuturePromiseFactory
  - newFailedFuture
```
public final <V> Future<V> newFailedFuture(Throwable cause)
```
    Description copied from interface: FuturePromiseFactory
    
    Create a new Future which is marked as failed already. So AsynchronousResult.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
    
    Specified by:
    
    newFailedFuture in interface FuturePromiseFactory
  - onUnhandledInboundException
```
protected void onUnhandledInboundException(Throwable cause)
```
    Called once a Throwable hit the end of the ChannelPipeline without been handled by the user in ChannelHandler.channelExceptionCaught(ChannelHandlerContext, Throwable).
  - onUnhandledInboundChannelActive
```
protected void onUnhandledInboundChannelActive()
```
    Called once the ChannelHandler.channelActive(ChannelHandlerContext)event hit the end of the ChannelPipeline.
  - onUnhandledInboundChannelInactive
```
protected void onUnhandledInboundChannelInactive()
```
    Called once the ChannelHandler.channelInactive(ChannelHandlerContext) event hit the end of the ChannelPipeline.
  - onUnhandledInboundChannelShutdown
```
protected void onUnhandledInboundChannelShutdown(ChannelShutdownDirection direction)
```
    Called once the ChannelHandler.channelShutdown(ChannelHandlerContext, ChannelShutdownDirection) event hit the end of the ChannelPipeline.
  - 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 ChannelHandler.channelRead(ChannelHandlerContext, Object). This method is responsible to call Resource.dispose(Object) on the given msg at some point.
  - onUnhandledInboundChannelReadComplete
```
protected void onUnhandledInboundChannelReadComplete()
```
    Called once the ChannelHandler.channelReadComplete(ChannelHandlerContext) event hit the end of the ChannelPipeline.
  - onUnhandledChannelInboundEvent
```
protected void onUnhandledChannelInboundEvent(Object evt)
```
    Called once an user event hit the end of the ChannelPipeline without been handled by the user in ChannelHandler.channelInboundEvent(ChannelHandlerContext, Object). This method is responsible to call Resource.dispose(Object) on the given event at some point.
  - onUnhandledChannelWritabilityChanged
```
protected void onUnhandledChannelWritabilityChanged()
```
    Called once the ChannelHandler.channelWritabilityChanged(ChannelHandlerContext) event hit the end of the ChannelPipeline.
  - pendingOutboundBytesUpdated
```
protected abstract void pendingOutboundBytesUpdated(long pendingOutboundBytes)
```
    Called once the pendingOutboundBytes() were changed.
    
    Parameters:
    
    pendingOutboundBytes - the new pendingOutboundBytes().
  - pendingOutboundBytes
```
public final long pendingOutboundBytes()
```
    Description copied from interface: ChannelPipeline
    
    The number of the outbound bytes that are buffered / queued in this ChannelPipeline. This number will affect the writability of the Channel together the buffered / queued bytes in the Channel itself.
    
    Specified by:
    
    pendingOutboundBytes in interface ChannelPipeline
    
    Returns:
    
    the number of buffered / queued bytes.
  - transportExecutor
```
protected abstract EventExecutor transportExecutor()
```
    Returns the EventExecutor that is used for all the abstract transport operations.
    
    Returns:
    
    executor.
  - registerTransport
```
protected abstract void registerTransport(Promise<Void> promise)
```
    Register the transport and notify the Promise once the operation was completed. This method is guaranteed to be called from the transportExecutor().
  - bindTransport
```
protected abstract void bindTransport(SocketAddress localAddress,
                                      Promise<Void> promise)
```
    Bind the SocketAddress to the transport and notify the Promise once the operation was completed. This method is guaranteed to be called from the transportExecutor().
  - connectTransport
```
protected abstract void connectTransport(SocketAddress remoteAddress,
                                         SocketAddress localAddress,
                                         Promise<Void> promise)
```
    Connect the transport with the given remote SocketAddress. If a specific local SocketAddress should be used it needs to be given as argument. Otherwise just pass null to it. The Promise will get notified once the operation was completed. This method is guaranteed to be called from the transportExecutor().
  - disconnectTransport
```
protected abstract void disconnectTransport(Promise<Void> promise)
```
    Disconnect the transport and notify the Promise once the operation was completed. This method is guaranteed to be called from the transportExecutor().
  - closeTransport
```
protected abstract void closeTransport(Promise<Void> promise)
```
    Close the transport and notify the Promise once the operation was completed. This method is guaranteed to be called from the transportExecutor().
  - shutdownTransport
```
protected abstract void shutdownTransport(ChannelShutdownDirection direction,
                                          Promise<Void> promise)
```
    Shutdown the given direction of the transport and notify the Promise once the operation was completed. This method is guaranteed to be called from the transportExecutor().
  - deregisterTransport
```
protected abstract void deregisterTransport(Promise<Void> promise)
```
    Deregister the transport of the EventLoop and notify the Promise once the operation was completed. This method is guaranteed to be called from the transportExecutor().
  - readTransport
```
protected abstract void readTransport()
```
    Schedules a read operation on the transport that fills the inbound buffer of the first ChannelHandler in the ChannelPipeline. If there's already a pending read operation, this method does nothing. This method is guaranteed to be called from the transportExecutor().
  - writeTransport
```
protected abstract void writeTransport(Object msg,
                                       Promise<Void> promise)
```
    Schedules a write operation on the transport. The given Promise will be notified once the write was either successful or failed. This method is guaranteed to be called from the transportExecutor().
  - flushTransport
```
protected abstract void flushTransport()
```
    Flush out all (previous) scheduled write operations, scheduled via writeTransport(Object, Promise). This method is guaranteed to be called from the transportExecutor().
  - sendOutboundEventTransport
```
protected abstract void sendOutboundEventTransport(Object event,
                                                   Promise<Void> promise)
```
    Send a custom outbound event on the transport. This method is guaranteed to be called from the transportExecutor().

Class DefaultChannelPipeline

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty5.channel.ChannelPipeline

Methods inherited from interface java.lang.Iterable

Constructor Detail

DefaultChannelPipeline

Method Detail

channel

executor

addFirst

addLast

addBefore

addAfter

addFirst

addFirst

addLast

addLast

remove

remove

remove

removeIfExists

removeIfExists

removeIfExists

replace

replace

replace

get

get

context

context

context

names

toString

removeFirst

removeLast

first

firstContext

last

lastContext

toMap

iterator

fireChannelRegistered

fireChannelUnregistered

fireChannelActive

fireChannelInactive

fireChannelShutdown

fireChannelExceptionCaught

fireChannelInboundEvent

fireChannelRead

fireChannelReadComplete

fireChannelWritabilityChanged

bind

connect

connect

disconnect

close

shutdown

register

deregister

flush

read

write

writeAndFlush

sendOutboundEvent

newPromise

newSucceededFuture

newSucceededFuture

newFailedFuture

onUnhandledInboundException

onUnhandledInboundChannelActive

onUnhandledInboundChannelInactive

onUnhandledInboundChannelShutdown

onUnhandledInboundMessage

onUnhandledInboundChannelReadComplete

onUnhandledChannelInboundEvent

onUnhandledChannelWritabilityChanged

pendingOutboundBytesUpdated

pendingOutboundBytes