ChannelPipelineImpl

cc.otavia.core.channel.ChannelPipelineImpl
See theChannelPipelineImpl companion object
final class ChannelPipelineImpl(val channel: AbstractChannel) extends ChannelPipeline

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

override def addAfter(baseName: String, name: Option[String], handler: ChannelHandler): ChannelPipeline

Inserts a ChannelHandler after an existing handler of this pipeline.

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

Definition Classes
override def addBefore(baseName: String, name: Option[String], handler: ChannelHandler): ChannelPipeline

Inserts a ChannelHandler before an existing handler of this pipeline.

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

Definition Classes
override def addFirst(name: Option[String], handler: ChannelHandler): ChannelPipeline

Inserts a ChannelHandler at the first position of this pipeline.

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

Definition Classes
override def addFirst(handlers: ChannelHandler*): ChannelPipeline

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

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

Value parameters

handlers

the handlers to insert first

Attributes

Definition Classes
override def addLast(name: Option[String], handler: ChannelHandler): ChannelPipeline

Appends a ChannelHandler at the last position of this pipeline.

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

Definition Classes
override def addLast(handlers: ChannelHandler*): ChannelPipeline

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

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

Value parameters

handlers

the handlers to insert last

Attributes

Definition Classes
override def bind(local: SocketAddress, future: ChannelFuture): ChannelFuture

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.

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

Definition Classes
override def close(future: ChannelFuture): ChannelFuture

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.

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

Definition Classes
override def connect(remote: SocketAddress, local: Option[SocketAddress], future: ChannelFuture): ChannelFuture

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.

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

Definition Classes
override def context(handler: ChannelHandler): Option[ChannelHandlerContext]

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

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.

Definition Classes
override def context(name: String): Option[ChannelHandlerContext]

Returns the context object of the ChannelHandler with the specified name 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.

Definition Classes
override def context(handlerType: Class[_ <: ChannelHandler]): Option[ChannelHandlerContext]

Returns the context object of the ChannelHandler of the specified type 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.

Definition Classes
def decrementPendingOutboundBytes(delta: Long): Unit

Decrements the pendingOutboundBytes of the pipeline by the given delta.

Decrements the pendingOutboundBytes of the pipeline by the given delta.

Value parameters

delta

the number of bytes to remove.

Attributes

override def deregister(future: ChannelFuture): ChannelFuture

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.

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

Definition Classes
override def disconnect(future: ChannelFuture): ChannelFuture

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.

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

Definition Classes
override def executor: ChannelsActor[_]

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

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

Attributes

Definition Classes
override def fireChannelActive(): this.type

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.

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

Definition Classes
override def fireChannelExceptionCaught(cause: Throwable): this.type

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.

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

Definition Classes
override def fireChannelExceptionCaught(cause: Throwable, id: Long): this.type

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.

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

Definition Classes
override def fireChannelInactive(): this.type

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.

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

Definition Classes
override def fireChannelInboundEvent(event: AnyRef): this.type

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.

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

Definition Classes
override def fireChannelRead(msg: AnyRef): this.type

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.

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

Definition Classes
override def fireChannelRead(msg: AnyRef, msgId: Long): this.type

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.

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

Definition Classes
override def fireChannelReadComplete(): this.type

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

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

Attributes

Definition Classes
override def fireChannelRegistered(): this.type

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.

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

Definition Classes
override def fireChannelShutdown(direction: ChannelShutdownDirection): this.type

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.

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

Definition Classes
override def fireChannelTimeoutEvent(id: Long): this.type

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.

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

Definition Classes
override def fireChannelUnregistered(): this.type

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.

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

Definition Classes
override def fireChannelWritabilityChanged(): this.type

Attributes

Definition Classes
override def firstContext: Option[ChannelHandlerContext]

Returns the context of the first ChannelHandler 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.

Definition Classes
override def flush(): this.type

Request to flush all pending messages via this ChannelOutboundInvoker.

Request to flush all pending messages via this ChannelOutboundInvoker.

Attributes

Definition Classes
def forceCloseTransport(): Unit
override def get(name: String): Option[ChannelHandler]

Returns the ChannelHandler with the specified name in this pipeline.

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.

Definition Classes
override def get[T <: ChannelHandler](handlerType: Class[T]): Option[T]

Returns the ChannelHandler of the specified type in this pipeline.

Returns the ChannelHandler of the specified type in this pipeline.

Attributes

Returns

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

Definition Classes
def incrementPendingOutboundBytes(delta: Long): Unit

Increments the pendingOutboundBytes of the pipeline by the given delta.

Increments the pendingOutboundBytes of the pipeline by the given delta.

Value parameters

delta

the number of bytes to add.

Attributes

override def inflightFutures: QueueMap[ChannelPromise]

Attributes

Definition Classes
override def inflightStacks[T <: AnyRef]: QueueMap[ChannelStack[T]]

Attributes

Definition Classes
override def lastContext: Option[ChannelHandlerContext]

Returns the context of the last ChannelHandler in this pipeline.

Returns the context of the last ChannelHandler in this pipeline.

Attributes

Returns

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

Definition Classes
override def open(ph: Path, opts: Seq[OpenOption], as: Seq[FileAttribute[_]], fu: ChannelFuture): ChannelFuture

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

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

  1. IllegalArgumentException - If the set contains an invalid combination of options
  2. UnsupportedOperationException – If the path is associated with a provider that does not support creating file channels, or an unsupported open option is specified.
  3. 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
  4. 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

Definition Classes
override def pendingOutboundBytes: Long

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.

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.

Definition Classes
override def read(readPlan: ReadPlan): this.type

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.

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

Definition Classes
override def read(): this.type

Attributes

Definition Classes
override def register(future: ChannelFuture): ChannelFuture

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.

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

Definition Classes
override def remove(handler: ChannelHandler): ChannelPipeline

Removes the specified ChannelHandler from this pipeline.

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

Definition Classes
override def remove(name: String): Option[ChannelHandler]

Removes the ChannelHandler with the specified name from this pipeline.

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

Definition Classes
override def remove[T <: ChannelHandler](handlerType: Class[T]): Option[T]

Removes the ChannelHandler of the specified type from this pipeline.

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

Definition Classes
override def removeFirst(): Option[ChannelHandler]

Removes the first ChannelHandler in this pipeline.

Removes the first ChannelHandler in this pipeline.

Attributes

Returns

the removed handler, None if this pipeline is empty

Definition Classes
override def removeIfExists[T <: ChannelHandler](name: String): Option[T]

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

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

Definition Classes
override def removeIfExists[T <: ChannelHandler](handlerType: Class[T]): Option[T]

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

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

Value parameters

<

T> the type of the handler

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

Definition Classes
override def removeIfExists[T <: ChannelHandler](handler: ChannelHandler): Option[T]

Removes the specified ChannelHandler from this pipeline if it exists

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

Definition Classes
override def removeLast(): Option[ChannelHandler]

Removes the last ChannelHandler in this pipeline.

Removes the last ChannelHandler in this pipeline.

Attributes

Returns

the removed handler, None if this pipeline is empty

Definition Classes
override def replace(old: ChannelHandler, newName: Option[String], newHandler: ChannelHandler): ChannelPipeline

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

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

old

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

Definition Classes
override def replace(old: String, newName: Option[String], newHandler: ChannelHandler): ChannelHandler

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

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

old

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

Definition Classes
override def replace[T <: ChannelHandler](old: Class[T], newName: Option[String], newHandler: ChannelHandler): T

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

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

old

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

Definition Classes
override def sendOutboundEvent(event: AnyRef): Unit

Send a custom outbound event via this ChannelOutboundInvoker through the ChannelPipeline. This will result in having the

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

Definition Classes
override def shutdown(direction: ChannelShutdownDirection, future: ChannelFuture): ChannelFuture

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.

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

Definition Classes
override def toMap: Map[String, ChannelHandler]

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

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

Attributes

Definition Classes
def touch(msg: AnyRef, next: ChannelHandlerContextImpl): AnyRef
override def write(msg: AnyRef): Unit

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.

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

Definition Classes
override def write(msg: AnyRef, msgId: Long): Unit

Attributes

Definition Classes
override def writeAndFlush(msg: AnyRef): Unit

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

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

Attributes

Definition Classes
override def writeAndFlush(msg: AnyRef, msgId: Long): Unit

Attributes

Definition Classes

Inherited methods

Inserts a ChannelHandler at the first position of this pipeline.

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

Inherited from:
ChannelPipeline

Appends a ChannelHandler at the last position of this pipeline.

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

Inherited from:
ChannelPipeline
final def assertInExecutor(): Unit

Attributes

Inherited from:
ChannelPipeline
final def connect(remote: SocketAddress, future: ChannelFuture): ChannelFuture

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.

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
def first: Option[ChannelHandler]

Returns the first ChannelHandler in this pipeline.

Returns the first ChannelHandler in this pipeline.

Attributes

Returns

the first handler. None if this pipeline is empty.

Inherited from:
ChannelPipeline
def isEmpty: Boolean

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

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

Attributes

Inherited from:
ChannelPipeline
def last: Option[ChannelHandler]

Returns the last ChannelHandler in this pipeline.

Returns the last ChannelHandler in this pipeline.

Attributes

Returns

the last handler. None if this pipeline is empty.

Inherited from:
ChannelPipeline
final def names: Iterable[String]

Returns the Iterable of the handler names.

Returns the Iterable of the handler names.

Attributes

Inherited from:
ChannelPipeline
final def open(file: File, options: Seq[OpenOption], attrs: Seq[FileAttribute[_]], future: ChannelFuture): ChannelFuture

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

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

  1. IllegalArgumentException - If the set contains an invalid combination of options
  2. UnsupportedOperationException – If the path is associated with a provider that does not support creating file channels, or an unsupported open option is specified.
  3. 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
  4. 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
final def system: ActorSystem

Attributes

Inherited from:
ChannelOutboundInvoker

Concrete fields

override val channel: AbstractChannel

Returns the Channel that this pipeline is attached to.

Returns the Channel that this pipeline is attached to.

Attributes

Returns

the channel.