io.netty.channel

Class DefaultChannelPipeline

java.lang.Object

io.netty.channel.DefaultChannelPipeline

All Implemented Interfaces:

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

public class DefaultChannelPipeline
extends java.lang.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)

Method Summary

Modifier and Type	Method and Description
ChannelPipeline	addAfter(EventExecutorGroup group, java.lang.String baseName, java.lang.String name, ChannelHandler handler) Inserts a ChannelHandler after an existing handler of this pipeline.
ChannelPipeline	addAfter(java.lang.String baseName, java.lang.String name, ChannelHandler handler) Inserts a ChannelHandler after an existing handler of this pipeline.
ChannelPipeline	addBefore(EventExecutorGroup group, java.lang.String baseName, java.lang.String name, ChannelHandler handler) Inserts a ChannelHandler before an existing handler of this pipeline.
ChannelPipeline	addBefore(java.lang.String baseName, java.lang.String name, ChannelHandler handler) Inserts a ChannelHandler before an existing handler of this pipeline.
ChannelPipeline	addFirst(ChannelHandler... handlers) Inserts ChannelHandlers at the first position of this pipeline.
ChannelPipeline	addFirst(EventExecutorGroup executor, ChannelHandler... handlers) Inserts ChannelHandlers at the first position of this pipeline.
ChannelPipeline	addFirst(EventExecutorGroup group, java.lang.String name, ChannelHandler handler) Inserts a ChannelHandler at the first position of this pipeline.
ChannelPipeline	addFirst(java.lang.String name, ChannelHandler handler) Inserts a ChannelHandler at the first position of this pipeline.
ChannelPipeline	addLast(ChannelHandler... handlers) Inserts ChannelHandlers at the last position of this pipeline.
ChannelPipeline	addLast(EventExecutorGroup executor, ChannelHandler... handlers) Inserts ChannelHandlers at the last position of this pipeline.
ChannelPipeline	addLast(EventExecutorGroup group, java.lang.String name, ChannelHandler handler) Appends a ChannelHandler at the last position of this pipeline.
ChannelPipeline	addLast(java.lang.String name, ChannelHandler handler) Appends a ChannelHandler at the last position of this pipeline.
ChannelFuture	bind(java.net.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(java.net.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 bound to this ChannelPipeline and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	connect(java.net.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(java.net.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(java.net.SocketAddress remoteAddress, java.net.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(java.net.SocketAddress remoteAddress, java.net.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(java.lang.Class<? extends ChannelHandler> handlerType) Returns the context object of the ChannelHandler of the specified type in this pipeline.
ChannelHandlerContext	context(java.lang.String name) Returns the context object of the ChannelHandler with the specified name in this pipeline.
ChannelFuture	deregister() Request to deregister the Channel 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 the Channel bound this ChannelPipeline 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(java.lang.Object msg) A Channel received a message.
ChannelPipeline	fireChannelReadComplete() Triggers an ChannelInboundHandler.channelReadComplete(ChannelHandlerContext) event to the next ChannelInboundHandler in the ChannelPipeline.
ChannelPipeline	fireChannelRegistered() A Channel was registered to its EventLoop.
ChannelPipeline	fireChannelUnregistered() A Channel was unregistered from its EventLoop.
ChannelPipeline	fireChannelWritabilityChanged() Triggers an ChannelInboundHandler.channelWritabilityChanged(ChannelHandlerContext) event to the next ChannelInboundHandler in the ChannelPipeline.
ChannelPipeline	fireExceptionCaught(java.lang.Throwable cause) A Channel received an Throwable in one of its inbound operations.
ChannelPipeline	fireUserEventTriggered(java.lang.Object event) A Channel received an user defined event.
ChannelHandler	first() Returns the first ChannelHandler in this pipeline.
ChannelHandlerContext	firstContext() Returns the context of the first ChannelHandler in this pipeline.
ChannelPipeline	flush() Request to flush all pending messages.
<T extends ChannelHandler> T	get(java.lang.Class<T> handlerType) Returns the ChannelHandler of the specified type in this pipeline.
ChannelHandler	get(java.lang.String name) Returns the ChannelHandler with the specified name in this pipeline.
java.util.Iterator<java.util.Map.Entry<java.lang.String,ChannelHandler>>	iterator()
ChannelHandler	last() Returns the last ChannelHandler in this pipeline.
ChannelHandlerContext	lastContext() Returns the context of the last ChannelHandler in this pipeline.
java.util.List<java.lang.String>	names() Returns the List of the handler names.
protected void	onUnhandledInboundException(java.lang.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(java.lang.Object msg) Called once a message hit the end of the ChannelPipeline without been handled by the user in ChannelInboundHandler.channelRead(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(java.lang.Class<T> handlerType) Removes the ChannelHandler of the specified type from this pipeline.
ChannelHandler	remove(java.lang.String name) Removes the ChannelHandler with the specified name from this pipeline.
ChannelHandler	removeFirst() Removes the first ChannelHandler in this pipeline.
ChannelHandler	removeLast() Removes the last ChannelHandler in this pipeline.
ChannelPipeline	replace(ChannelHandler oldHandler, java.lang.String newName, ChannelHandler newHandler) Replaces the specified ChannelHandler with a new handler in this pipeline.
<T extends ChannelHandler> T	replace(java.lang.Class<T> oldHandlerType, java.lang.String newName, ChannelHandler newHandler) Replaces the ChannelHandler of the specified type with a new handler in this pipeline.
ChannelHandler	replace(java.lang.String oldName, java.lang.String newName, ChannelHandler newHandler) Replaces the ChannelHandler of the specified name with a new handler in this pipeline.
java.util.Map<java.lang.String,ChannelHandler>	toMap() Converts this pipeline into an ordered Map whose keys are handler names and whose values are handlers.
java.lang.String	toString() Returns the String representation of this pipeline.
ChannelFuture	write(java.lang.Object msg) Request to write a message via this ChannelPipeline.
ChannelFuture	write(java.lang.Object msg, ChannelPromise promise) Request to write a message via this ChannelPipeline.
ChannelFuture	writeAndFlush(java.lang.Object msg) Shortcut for call ChannelPipeline.write(Object) and ChannelPipeline.flush().
ChannelFuture	writeAndFlush(java.lang.Object msg, ChannelPromise promise) Shortcut for call ChannelPipeline.write(Object, ChannelPromise) and ChannelPipeline.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(java.lang.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,
                                      java.lang.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(java.lang.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,
                                     java.lang.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(java.lang.String baseName,
                                       java.lang.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,
                                       java.lang.String baseName,
                                       java.lang.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(java.lang.String baseName,
                                      java.lang.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,
                                      java.lang.String baseName,
                                      java.lang.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... 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... 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(java.lang.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(java.lang.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

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,
                                     java.lang.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(java.lang.String oldName,
                                    java.lang.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(java.lang.Class<T> oldHandlerType,
                                                  java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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 java.util.List<java.lang.String> names()

Description copied from interface: ChannelPipeline

Returns the List of the handler names.

Specified by:

names in interface ChannelPipeline

toMap

public final java.util.Map<java.lang.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 java.util.Iterator<java.util.Map.Entry<java.lang.String,ChannelHandler>> iterator()

Specified by:

iterator in interface java.lang.Iterable<java.util.Map.Entry<java.lang.String,ChannelHandler>>

toString

public final java.lang.String toString()

Returns the String representation of this pipeline.

Overrides:

toString in class java.lang.Object

fireChannelRegistered

public final ChannelPipeline fireChannelRegistered()

Description copied from interface: ChannelPipeline

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 ChannelPipeline

fireChannelUnregistered

public final ChannelPipeline fireChannelUnregistered()

Description copied from interface: ChannelPipeline

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 ChannelPipeline

fireChannelActive

public final ChannelPipeline fireChannelActive()

Description copied from interface: ChannelPipeline

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 ChannelPipeline

fireChannelInactive

public final ChannelPipeline fireChannelInactive()

Description copied from interface: ChannelPipeline

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 ChannelPipeline

fireExceptionCaught

public final ChannelPipeline fireExceptionCaught(java.lang.Throwable cause)

Description copied from interface: ChannelPipeline

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 ChannelPipeline

fireUserEventTriggered

public final ChannelPipeline fireUserEventTriggered(java.lang.Object event)

Description copied from interface: ChannelPipeline

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 ChannelPipeline

fireChannelRead

public final ChannelPipeline fireChannelRead(java.lang.Object msg)

Description copied from interface: ChannelPipeline

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 ChannelPipeline

fireChannelReadComplete

public final ChannelPipeline fireChannelReadComplete()

Description copied from interface: ChannelPipeline

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

Specified by:

fireChannelReadComplete in interface ChannelPipeline

fireChannelWritabilityChanged

public final ChannelPipeline fireChannelWritabilityChanged()

Description copied from interface: ChannelPipeline

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

Specified by:

fireChannelWritabilityChanged in interface ChannelPipeline

bind

public final ChannelFuture bind(java.net.SocketAddress localAddress)

Description copied from interface: ChannelPipeline

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 ChannelPipeline

connect

public final ChannelFuture connect(java.net.SocketAddress remoteAddress)

Description copied from interface: ChannelPipeline

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 ChannelPipeline

connect

public final ChannelFuture connect(java.net.SocketAddress remoteAddress,
                                   java.net.SocketAddress localAddress)

Description copied from interface: ChannelPipeline

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 ChannelPipeline

disconnect

public final ChannelFuture disconnect()

Description copied from interface: ChannelPipeline

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 ChannelPipeline

close

public final ChannelFuture close()

Description copied from interface: ChannelPipeline

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 ChannelPipeline

deregister

public final ChannelFuture deregister()

Description copied from interface: ChannelPipeline

Request to deregister the Channel 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 ChannelPipeline

flush

public final ChannelPipeline flush()

Description copied from interface: ChannelPipeline

Request to flush all pending messages.

Specified by:

flush in interface ChannelPipeline

bind

public final ChannelFuture bind(java.net.SocketAddress localAddress,
                                ChannelPromise promise)

Description copied from interface: ChannelPipeline

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 ChannelPipeline

connect

public final ChannelFuture connect(java.net.SocketAddress remoteAddress,
                                   ChannelPromise promise)

Description copied from interface: ChannelPipeline

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 ChannelPipeline

connect

public final ChannelFuture connect(java.net.SocketAddress remoteAddress,
                                   java.net.SocketAddress localAddress,
                                   ChannelPromise promise)

Description copied from interface: ChannelPipeline

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 ChannelPipeline

disconnect

public final ChannelFuture disconnect(ChannelPromise promise)

Description copied from interface: ChannelPipeline

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 ChannelPipeline

close

public final ChannelFuture close(ChannelPromise promise)

Description copied from interface: ChannelPipeline

Request to close the Channel bound to this ChannelPipeline 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 ChannelPipeline

deregister

public final ChannelFuture deregister(ChannelPromise promise)

Description copied from interface: ChannelPipeline

Request to deregister the Channel bound this ChannelPipeline 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 ChannelPipeline

read

public final ChannelPipeline read()

Description copied from interface: ChannelPipeline

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 ChannelPipeline

write

public final ChannelFuture write(java.lang.Object msg)

Description copied from interface: ChannelPipeline

Request to write a message via this ChannelPipeline. This method will not request to actual flush, so be sure to call ChannelPipeline.flush() once you want to request to flush all pending data to the actual transport.

Specified by:

write in interface ChannelPipeline

write

public final ChannelFuture write(java.lang.Object msg,
                                 ChannelPromise promise)

Description copied from interface: ChannelPipeline

Request to write a message via this ChannelPipeline. This method will not request to actual flush, so be sure to call ChannelPipeline.flush() once you want to request to flush all pending data to the actual transport.

Specified by:

write in interface ChannelPipeline

writeAndFlush

public final ChannelFuture writeAndFlush(java.lang.Object msg,
                                         ChannelPromise promise)

Description copied from interface: ChannelPipeline

Shortcut for call ChannelPipeline.write(Object, ChannelPromise) and ChannelPipeline.flush().

Specified by:

writeAndFlush in interface ChannelPipeline

writeAndFlush

public final ChannelFuture writeAndFlush(java.lang.Object msg)

Description copied from interface: ChannelPipeline

Shortcut for call ChannelPipeline.write(Object) and ChannelPipeline.flush().

Specified by:

writeAndFlush in interface ChannelPipeline

onUnhandledInboundException

protected void onUnhandledInboundException(java.lang.Throwable cause)

Called once a Throwable hit the end of the ChannelPipeline without been handled by the user in ChannelHandler.exceptionCaught(ChannelHandlerContext, Throwable).

onUnhandledInboundMessage

protected void onUnhandledInboundMessage(java.lang.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.