otavia/cc.otavia/cc.otavia.core/cc.otavia.core.channel/ChannelPipeline

ChannelPipeline

cc.otavia.core.channel.ChannelPipeline

trait ChannelPipeline extends ChannelInboundInvoker, ChannelOutboundInvoker

Attributes

Graph
Supertypes: trait ChannelOutboundInvoker

trait ChannelInboundInvoker

class Object

trait Matchable

class Any
Known subtypes: class ChannelPipelineImpl

Members list

Value members

Abstract methods

Inserts a ChannelHandler after an existing handler of this pipeline.

Value parameters

baseName: the name of the existing handler
handler: the handler to insert after
name: the name of the handler to insert after

Attributes

Throws: IllegalArgumentException
if there's an entry with the same name already in the pipeline

NoSuchElementException
if there's no such entry with the specified baseName

NullPointerException
if the specified baseName or handler is null

Inserts a ChannelHandler before an existing handler of this pipeline.

Value parameters

baseName: the name of the existing handler
handler: the handler to insert before
name: the name of the handler to insert before

Attributes

Throws: IllegalArgumentException
if there's an entry with the same name already in the pipeline

NoSuchElementException
if there's no such entry with the specified baseName

NullPointerException
if the specified baseName or handler is null

Inserts a ChannelHandler at the first position of this pipeline.

Value parameters

handler: the handler to insert first
name: the name of the handler to insert first

Attributes

Returns: itself.
Throws: IllegalArgumentException
if there's an entry with the same name already in the pipeline

NullPointerException
if the specified handler is null

Inserts ChannelHandlers at the first position of this pipeline. null handlers will be skipped.

Value parameters

handlers: the handlers to insert first

Attributes

Appends a ChannelHandler at the last position of this pipeline.

Value parameters

handler: the handler to append
name: the name of the handler to append

Attributes

Throws: IllegalArgumentException
if there's an entry with the same name already in the pipeline

NullPointerException
if the specified handler is null

Inserts ChannelHandlers at the last position of this pipeline. null handlers will be skipped.

Value parameters

handlers: the handlers to insert last

Attributes

Returns the Channel that this pipeline is attached to.

Attributes

Returns: the channel.

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

Attributes

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

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

Attributes

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

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

Attributes

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

Returns the context of the first ChannelHandler in this pipeline.

Attributes

Returns: the context of the first handler. None if this pipeline is empty.

Returns the ChannelHandler with the specified name in this pipeline.

Attributes

Returns: the handler with the specified name. None if there's no such handler in this pipeline.

Returns the ChannelHandler of the specified type in this pipeline.

Attributes

Returns: the handler of the specified handler type. None if there's no such handler in this pipeline.

Returns the context of the last ChannelHandler in this pipeline.

Attributes

Returns: the context of the last handler. None if this pipeline is empty.

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.

Attributes

Returns: the number of buffered / queued bytes.

Removes the specified ChannelHandler from this pipeline.

Value parameters

handler: the ChannelHandler to remove

Attributes

Throws: NoSuchElementException
if there's no such handler in this pipeline

NullPointerException
if the specified handler is null

Removes the ChannelHandler with the specified name from this pipeline.

Value parameters

name: the name under which the ChannelHandler was stored.

Attributes

Returns: the removed handler
Throws: NoSuchElementException
if there's no such handler with the specified name in this pipeline

NullPointerException
if the specified name is null

Removes the ChannelHandler of the specified type from this pipeline.

Type parameters

T: the type of the handler

Value parameters

handlerType: the type of the handler

Attributes

Returns: the removed handler
Throws: NoSuchElementException
if there's no such handler of the specified type in this pipeline

NullPointerException
if the specified handler type is null

Removes the first ChannelHandler in this pipeline.

Attributes

Returns: the removed handler, None if this pipeline is empty

Removes the ChannelHandler with the specified name from this pipeline if it exists.

Value parameters

name: the name under which the ChannelHandler was stored.

Attributes

Returns: the removed handler
Throws: NoSuchElementException
if there's no such handler with the specified name in this pipeline

NullPointerException
if the specified name is null

Removes the ChannelHandler of the specified type from this pipeline if it exists.

Type parameters

T: the type of the handler

Value parameters

handlerType: the type of the handler

Attributes

Returns: the removed handler or null if it didn't exist.
Throws: NullPointerException
if the specified handler type is null

Removes the specified ChannelHandler from this pipeline if it exists

Value parameters

handler: the ChannelHandler to remove

Attributes

Returns: the removed handler or null if it didn't exist.
Throws: NullPointerException
if the specified handler is null

Removes the last ChannelHandler in this pipeline.

Attributes

Returns: the removed handler, None if this pipeline is empty

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

Value parameters

newHandler: the ChannelHandler which is used as replacement
newName: the name under which the replacement should be added
oldHandler: the ChannelHandler to be replaced

Attributes

Returns: itself
Throws: IllegalArgumentException
if a handler with the specified new name already exists in this pipeline, except for the handler to be replaced

NoSuchElementException
if the specified old handler does not exist in this pipeline

NullPointerException
if the specified old handler or new handler is null

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

Value parameters

newHandler: the ChannelHandler which is used as replacement
newName: the name under which the replacement should be added
oldName: the name of the ChannelHandler to be replaced

Attributes

Returns: the removed handler
Throws: IllegalArgumentException
if a handler with the specified new name already exists in this pipeline, except for the handler to be replaced

NoSuchElementException
if the handler with the specified old name does not exist in this pipeline

NullPointerException
if the specified old handler or new handler is null

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

Value parameters

newHandler: the ChannelHandler which is used as replacement
newName: the name under which the replacement should be added
oldHandlerType: the type of the handler to be removed

Attributes

Returns: the removed handler
Throws: IllegalArgumentException
if a handler with the specified new name already exists in this pipeline, except for the handler to be replaced

NoSuchElementException
if the handler of the specified old handler type does not exist in this pipeline

NullPointerException
if the specified old handler or new handler is null

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

Attributes

Concrete methods

Inserts a ChannelHandler at the first position of this pipeline.

Value parameters

handler: the handler to insert first

Attributes

Returns: itself.
Throws: IllegalArgumentException
if there's an entry with the same name already in the pipeline

NullPointerException
if the specified handler is null

Appends a ChannelHandler at the last position of this pipeline.

Value parameters

handler: the handler to append

Attributes

Throws: IllegalArgumentException
if there's an entry with the same name already in the pipeline

NullPointerException
if the specified handler is null

Returns the first ChannelHandler in this pipeline.

Attributes

Returns: the first handler. None if this pipeline is empty.

Returns true if this ChannelPipeline is empty, which means no ChannelHandler is present.

Attributes

Returns the last ChannelHandler in this pipeline.

Attributes

Returns: the last handler. None if this pipeline is empty.

Returns the Iterable of the handler names.

Attributes

Inherited methods

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 SocketAddress) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.

Value parameters

future: bind async result
local: Address to bind

Attributes

Returns: same ChannelFuture in params future
Inherited from:: 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 ChannelHandler.close method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.

Value parameters

future: operation async result.

Attributes

Returns: same ChannelFuture in params future
Inherited from:: 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 SocketAddress, SocketAddress) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.

Value parameters

remote: remote address to connect.

Attributes

Inherited from:: ChannelOutboundInvoker

Request to connect to the given SocketAddress while bind to the local 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 SocketAddress, SocketAddress) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.

Value parameters

future: operation async result.
local: local address to bind.
remote: remote address to connect.

Attributes

Returns: same ChannelFuture in params future
Inherited from:: ChannelOutboundInvoker

Request to deregister from the previous Reactor 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 method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.

Value parameters

future: operation async result

Attributes

Returns: same ChannelFuture in params future
Inherited from:: 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 ChannelHandler.disconnect method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.

Value parameters

future: operation async result.

Attributes

Returns: same ChannelFuture in params future
Inherited from:: ChannelOutboundInvoker

Executor of this channel instance, the channel inbound and outbound event must execute in the binding executor

Attributes

Inherited from:: ChannelOutboundInvoker

A Channel is active now, which means it is connected or opened. This will result in having the ChannelHandler.channelActive method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.

Attributes

Inherited from:: ChannelInboundInvoker

A Channel received an Throwable in one of its inbound operations. This will result in having the Throwable) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.

Attributes

Inherited from:: ChannelInboundInvoker

A Channel received an Throwable in one of its inbound operations. This will result in having the Throwable) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.

Attributes

Inherited from:: ChannelInboundInvoker

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

Attributes

Inherited from:: ChannelInboundInvoker

A Channel received a custom defined inbound event. This will result in having the Object) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.

Attributes

Inherited from:: ChannelInboundInvoker

A Channel received a message. This will result in having the Object) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.

Attributes

Inherited from:: ChannelInboundInvoker

A Channel received a message. This will result in having the Object) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.

Attributes

Inherited from:: ChannelInboundInvoker

Triggers an ChannelHandler.channelReadComplete event to the next ChannelHandler in the ChannelPipeline.

Attributes

Inherited from:: ChannelInboundInvoker

A Channel was registered to Reactor. This will result in having the ChannelHandler.channelRegistered method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.

Attributes

Inherited from:: ChannelInboundInvoker

A Channel was shutdown in a specific direction. This will result in having the ChannelShutdownDirection) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.

Value parameters

direction: the direction of shutdown

Attributes

Inherited from:: ChannelInboundInvoker

A Channel received a custom defined timeout event. This will result in having the ChannelHandler.channelTimeoutEvent method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.

Value parameters

id: timer task register id

Attributes

Inherited from:: ChannelInboundInvoker

A Channel was unregistered from Reactor. This will result in having the ChannelHandler.channelUnregistered method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.

Attributes

Inherited from:: ChannelInboundInvoker

Triggers an ChannelHandler.channelWritabilityChanged event to the next ChannelHandler in the ChannelPipeline.

Attributes

Inherited from:: ChannelInboundInvoker

Request to flush all pending messages via this ChannelOutboundInvoker.

Attributes

Inherited from:: ChannelOutboundInvoker

Opens or creates a file, returning a file channel to access the file. An invocation of this method behaves in exactly the same way as the invocation

options)

where options is a set of the options specified in the options array

This will result in having the ChannelHandler.open method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.

Value parameters

attrs

An optional list of file attributes to set atomically when creating the file

file

The file to open or create

future

operation async result. It maybe fails with

IllegalArgumentException - If the set contains an invalid combination of options
UnsupportedOperationException – If the path is associated with a provider that does not support creating file channels, or an unsupported open option is specified.
FileAlreadyExistsException – If a file of that name already exists and the CREATE_NEW option is specified and the file is being opened for writing (optional specific exception) IOException – If an I/O error occurs
SecurityException – If a security manager is installed and it denies an unspecified permission required by the implementation. In the case of the default provider, the SecurityManager.checkRead(String) method is invoked to check read access if the file is opened for reading. The SecurityManager.checkWrite(String) method is invoked to check write access if the file is opened for writing

options

Options specifying how the file is opened

Attributes

Returns: same ChannelFuture in params future
See also: FileChannel
Inherited from:: ChannelOutboundInvoker

Opens or creates a file, returning a file channel to access the file. An invocation of this method behaves in exactly the same way as the invocation

options)

where options is a set of the options specified in the options array

This will result in having the ChannelHandler.open method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.

Value parameters

attrs

An optional list of file attributes to set atomically when creating the file

future

operation async result. It maybe fails with

IllegalArgumentException - If the set contains an invalid combination of options
UnsupportedOperationException – If the path is associated with a provider that does not support creating file channels, or an unsupported open option is specified.
FileAlreadyExistsException – If a file of that name already exists and the CREATE_NEW option is specified and the file is being opened for writing (optional specific exception) IOException – If an I/O error occurs
SecurityException – If a security manager is installed and it denies an unspecified permission required by the implementation. In the case of the default provider, the SecurityManager.checkRead(String) method is invoked to check read access if the file is opened for reading. The SecurityManager.checkWrite(String) method is invoked to check write access if the file is opened for writing

options

Options specifying how the file is opened

path

The path of the file to open or create

Attributes

Returns: same ChannelFuture in params future
See also: FileChannel
Inherited from:: ChannelOutboundInvoker

Attributes

Inherited from:: ChannelOutboundInvoker

Request to read data from the Channel, triggers an 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 ReadBufferAllocator) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.

Attributes

Inherited from:: ChannelOutboundInvoker

Request to register on the Reactor for I/O processing. ChannelFuture once the operation completes, either because the operation was successful or because of an error. This will result in having the ChannelHandler.register method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.

Value parameters

future: operation async result

Attributes

Returns: same ChannelFuture in params future
Inherited from:: 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.

Attributes

Inherited from:: ChannelOutboundInvoker

Request shutdown one direction of the Channel and notify the ChannelFuture 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 ChannelShutdownDirection). method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.

Value parameters

direction: direction to shutdown
future: operation async result

Attributes

Returns: same ChannelFuture in params future
Inherited from:: ChannelOutboundInvoker

Attributes

Inherited from:: ChannelOutboundInvoker

Attributes

Inherited from:: 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 flush() once you want to request to flush all pending data to the actual transport.

Value parameters

msg: object to write

Attributes

Inherited from:: ChannelOutboundInvoker

Attributes

Inherited from:: ChannelOutboundInvoker

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

Attributes

Inherited from:: ChannelOutboundInvoker

In this article

Generated with