Interface Summary |
BackpressureBuffer.HighWatermarkReached |
Message type which is sent when the buffer’s high watermark has been
reached, which means that further write requests should not be sent
until the low watermark has been reached again. |
BackpressureBuffer.LowWatermarkReached |
Message type which is sent when the buffer’s fill level falls below
the low watermark, which means that writing can commence again. |
BufferPool |
|
HasActorContext |
This trait expresses that the pipeline’s context needs to live within an
actor and provide its ActorContext. |
HasLogging |
This trait expresses that the pipeline’s context needs to provide a logging
facility. |
Inet.SocketOption |
SocketOption is a package of data (from the user) and associated
behavior (how to apply that to a socket). |
Inet.SoForwarders |
|
Inet.SoJavaFactories |
|
IO.Extension |
|
PipelineContext |
This base trait of each pipeline’s context provides optimized facilities
for generating single commands or events (i.e. |
PipelineInjector<Cmd,Evt> |
A handle for injecting commands and events into a pipeline. |
PipePair<CmdAbove,CmdBelow,EvtAbove,EvtBelow> |
Scala API: A pair of pipes, one for commands and one for events, plus a
management port. |
SymmetricPipePair<Above,Below> |
A convenience type for expressing a PipePair which has the same types
for commands and events. |
Tcp.CloseCommand |
Common interface for all commands which aim to close down an open connection. |
Tcp.Command |
This is the common trait for all commands understood by TCP actors. |
Tcp.ConnectionClosed |
This is the common interface for all events which indicate that a connection
has been closed or half-closed. |
Tcp.Event |
Common interface for all events generated by the TCP layer actors. |
Tcp.Message |
The common interface for Tcp.WriteCommand and Tcp.Event . |
Tcp.SimpleWriteCommand |
Common supertype of Tcp.Write and Tcp.WriteFile . |
Tcp.Unbound |
The sender of an Unbind command will receive confirmation through this
message once the listening socket has been closed. |
Tcp.WriteCommand |
Common interface for all write commands, currently Tcp.Write , Tcp.WriteFile and Tcp.CompoundWrite . |
Tcp.WritingResumed |
When useResumeWriting is in effect as indicated in the Tcp.Register message,
the ResumeWriting command will be acknowledged by this message type, upon
which it is safe to send at least one write. |
TcpPipelineHandler.WithinActorContext |
This interface bundles logging and ActorContext for Java. |
TickGenerator.Trigger |
This message type is used by the TickGenerator to trigger
the rescheduling of the next Tick. |
Udp.Command |
The common type of all commands supported by the UDP implementation. |
Udp.Event |
The common type of all events emitted by the UDP implementation. |
Udp.Message |
The common interface for Udp.Command and Udp.Event . |
Udp.SimpleSenderReady |
The “simple sender” sends this message type in response to a Udp.SimpleSender query. |
Udp.Unbound |
This message is sent by the listener actor in response to an Unbind command
after the socket has been closed. |
UdpConnected.Command |
The common type of all commands supported by the UDP implementation. |
UdpConnected.Connected |
This message is sent by the connection actor to the actor which sent the
UdpConnected.Connect message when the UDP socket has been bound to the local and
remote addresses given. |
UdpConnected.Disconnected |
This message is sent by the connection actor to the actor which sent the
Disconnect message when the UDP socket has been closed. |
UdpConnected.Event |
The common type of all events emitted by the UDP implementation. |
UdpConnected.Message |
The common interface for UdpConnected.Command and UdpConnected.Event . |
Class Summary |
AbstractPipelineContext |
This base trait of each pipeline’s context provides optimized facilities
for generating single commands or events (i.e. |
AbstractPipePair<CmdAbove,CmdBelow,EvtAbove,EvtBelow> |
Java API: A pair of pipes, one for commands and one for events. |
AbstractSymmetricPipePair<Above,Below> |
A convenience type for expressing a AbstractPipePair which has the same types
for commands and events. |
BackpressureBuffer |
This pipeline stage implements a configurable buffer for transforming the
per-write ACK/NACK-based backpressure model of a TCP connection actor into
an edge-triggered back-pressure model: the upper stages will receive
notification when the buffer runs full (BackpressureBuffer.HighWatermarkReached ) and when
it subsequently empties (BackpressureBuffer.LowWatermarkReached ). |
BackpressureBuffer.HighWatermarkReached$ |
|
BackpressureBuffer.LowWatermarkReached$ |
|
BackpressureBuffer$ |
|
DelimiterFraming |
Pipeline stage for delimiter byte based framing and de-framing. |
DelimiterFraming$ |
|
Inet |
|
Inet.SO$ |
|
Inet$ |
|
IO |
Entry point to Akka’s IO layer. |
IO$ |
Entry point to Akka’s IO layer. |
LengthFieldFrame |
Pipeline stage for length-field encoded framing. |
LengthFieldFrame$ |
|
PipelineFactory |
This class contains static factory methods which turn a pipeline context
and a PipelineStage into readily usable pipelines. |
PipelineFactory$ |
This class contains static factory methods which turn a pipeline context
and a PipelineStage into readily usable pipelines. |
PipelinePorts<CmdAbove,CmdBelow,EvtAbove,EvtBelow> |
|
PipelinePorts$ |
|
PipelineSink<Cmd,Evt> |
A sink which can be attached by PipelineFactory.buildWithSink(Ctx, akka.io.PipelineStage, akka.io.PipelineSink) to a
pipeline when it is being built. |
PipelineStage<Context extends PipelineContext,CmdAbove,CmdBelow,EvtAbove,EvtBelow> |
A pipeline stage which can be combined with other stages to build a
protocol stack. |
PipelineStage$ |
|
PipePairFactory |
This class contains static factory methods which produce PipePair
instances; those are needed within the implementation of PipelineStage.apply(Context) . |
PipePairFactory$ |
This class contains static factory methods which produce PipePair
instances; those are needed within the implementation of PipelineStage.apply(Context) . |
SelectionHandlerSettings |
|
SslTlsSupport |
This pipeline stage implements SSL / TLS support, using an externally
configured SSLEngine . |
SslTlsSupport$ |
|
StringByteStringAdapter |
Simple convenience pipeline stage for turning Strings into ByteStrings and vice versa. |
StringByteStringAdapter$ |
|
SymmetricPipelineStage<Context extends PipelineContext,Above,Below> |
A PipelineStage which is symmetric in command and event types, i.e. |
Tcp |
TCP Extension for Akka’s IO layer. |
Tcp.Abort$ |
An abort operation will not flush pending writes and will issue a TCP ABORT
command to the O/S kernel which should result in a TCP_RST packet being sent
to the peer. |
Tcp.Aborted$ |
The connection has been aborted in response to an Abort command. |
Tcp.Bind |
The Bind message is send to the TCP manager actor, which is obtained via
TcpExt.manager() in order to bind to a listening socket. |
Tcp.Bind$ |
|
Tcp.Bound |
The sender of a Tcp.Bind command will—in case of success—receive confirmation
in this form. |
Tcp.Bound$ |
|
Tcp.Close$ |
A normal close operation will first flush pending writes and then close the
socket. |
Tcp.Closed$ |
The connection has been closed normally in response to a Close command. |
Tcp.CommandFailed |
Whenever a command cannot be completed, the queried actor will reply with
this message, wrapping the original command which failed. |
Tcp.CommandFailed$ |
|
Tcp.CompoundWrite |
A write command which aggregates two other write commands. |
Tcp.CompoundWrite$ |
|
Tcp.ConfirmedClose$ |
A confirmed close operation will flush pending writes and half-close the
connection, waiting for the peer to close the other half. |
Tcp.ConfirmedClosed$ |
The connection has been half-closed by us and then half-close by the peer
in response to a ConfirmedClose command. |
Tcp.Connect |
The Connect message is sent to the TCP manager actor, which is obtained via
TcpExt.manager() . |
Tcp.Connect$ |
|
Tcp.Connected |
The connection actor sends this message either to the sender of a Tcp.Connect
command (for outbound) or to the handler for incoming connections designated
in the Tcp.Bind message. |
Tcp.Connected$ |
|
Tcp.ErrorClosed |
The connection has been closed due to an IO error. |
Tcp.ErrorClosed$ |
|
Tcp.NoAck |
Each Tcp.WriteCommand can optionally request a positive acknowledgment to be sent
to the commanding actor. |
Tcp.NoAck$ |
Default Tcp.NoAck instance which is used when no acknowledgment information is
explicitly provided. |
Tcp.PeerClosed$ |
The peer has closed its writing half of the connection. |
Tcp.Received |
Whenever data are read from a socket they will be transferred within this
class to the handler actor which was designated in the Tcp.Register message. |
Tcp.Received$ |
|
Tcp.Register |
This message must be sent to a TCP connection actor after receiving the
Tcp.Connected message. |
Tcp.Register$ |
|
Tcp.ResumeReading$ |
This command needs to be sent to the connection actor after a SuspendReading
command in order to resume reading from the socket. |
Tcp.ResumeWriting$ |
When useResumeWriting is in effect as was indicated in the Tcp.Register message
then this command needs to be sent to the connection actor in order to re-enable
writing after a Tcp.CommandFailed event. |
Tcp.SO$ |
Scala API: this object contains all applicable socket options for TCP. |
Tcp.SuspendReading$ |
Sending this command to the connection actor will disable reading from the TCP
socket. |
Tcp.Unbind$ |
In order to close down a listening socket, send this message to that socket’s
actor (that is the actor which previously had sent the Tcp.Bound message). |
Tcp.Unbound$ |
|
Tcp.Write |
Write data to the TCP connection. |
Tcp.Write$ |
|
Tcp.WriteCommand$ |
|
Tcp.WriteFile |
Write count bytes starting at position from file at filePath to the connection. |
Tcp.WriteFile$ |
|
Tcp.WritingResumed$ |
|
Tcp$ |
TCP Extension for Akka’s IO layer. |
TcpExt |
|
TcpMessage |
|
TcpMessage$ |
|
TcpPipelineHandler<Ctx extends PipelineContext,Cmd,Evt> |
This actor wraps a pipeline and forwards commands and events between that
one and a Tcp connection actor. |
TcpPipelineHandler.Init<Ctx extends PipelineContext,Cmd,Evt> |
This class wraps up a pipeline with its external (i.e. |
TcpPipelineHandler.Management |
Wrapper class for management commands sent to the TcpPipelineHandler actor. |
TcpPipelineHandler.Management$ |
|
TcpPipelineHandler.TcpEvent |
The pipeline may want to emit a Tcp.Event to the registered handler
actor, which is enabled by emitting this Tcp.Command wrapping an event
instead. |
TcpPipelineHandler.TcpEvent$ |
|
TcpPipelineHandler.Tell |
This is a new Tcp.Command which the pipeline can emit to effect the
sending a message to another actor. |
TcpPipelineHandler.Tell$ |
|
TcpPipelineHandler$ |
|
TcpReadWriteAdapter |
Adapts a ByteString oriented pipeline stage to a stage that communicates via Tcp Commands and Events. |
TcpSO |
Java API for accessing socket options. |
TcpSO$ |
Java API for accessing socket options. |
TickGenerator<Cmd,Evt> |
This pipeline stage does not alter the events or commands |
TickGenerator.Tick |
This message type is emitted by the TickGenerator to the whole
pipeline, informing all stages about the time at which this Tick
was emitted (relative to some arbitrary epoch). |
TickGenerator.Tick$ |
|
TickGenerator$ |
|
Udp |
UDP Extension for Akka’s IO layer. |
Udp.Bind |
Send this message to the UdpExt.manager() in order to bind to the given
local port (or an automatically assigned one if the port number is zero). |
Udp.Bind$ |
|
Udp.Bound |
This message is sent by the listener actor in response to a Udp.Bind command. |
Udp.Bound$ |
|
Udp.CommandFailed |
When a command fails it will be replied to with this message type,
wrapping the failing command object. |
Udp.CommandFailed$ |
|
Udp.NoAck |
Each Udp.Send can optionally request a positive acknowledgment to be sent
to the commanding actor. |
Udp.NoAck$ |
Default Udp.NoAck instance which is used when no acknowledgment information is
explicitly provided. |
Udp.Received |
When a listener actor receives a datagram from its socket it will send
it to the handler designated in the Udp.Bind message using this message type. |
Udp.Received$ |
|
Udp.ResumeReading$ |
This message must be sent to the listener actor to re-enable reading from
the socket after a SuspendReading command. |
Udp.Send |
This message is understood by the “simple sender” which can be obtained by
sending the Udp.SimpleSender query to the UdpExt.manager() as well as by
the listener actors which are created in response to Udp.Bind . |
Udp.Send$ |
|
Udp.SimpleSender |
Retrieve a reference to a “simple sender” actor of the UDP extension. |
Udp.SimpleSender$ |
|
Udp.SimpleSenderReady$ |
|
Udp.SO$ |
Scala API: This object provides access to all socket options applicable to UDP sockets. |
Udp.SuspendReading$ |
Send this message to a listener actor (which sent a Udp.Bound message) to
have it stop reading datagrams from the network. |
Udp.Unbind$ |
Send this message to the listener actor that previously sent a Udp.Bound
message in order to close the listening socket. |
Udp.Unbound$ |
|
Udp$ |
UDP Extension for Akka’s IO layer. |
UdpConnected |
UDP Extension for Akka’s IO layer. |
UdpConnected.CommandFailed |
When a command fails it will be replied to with this message type,
wrapping the failing command object. |
UdpConnected.CommandFailed$ |
|
UdpConnected.Connect |
Send this message to the UdpExt.manager() in order to bind to a local
port (optionally with the chosen localAddress ) and create a UDP socket
which is restricted to sending to and receiving from the given remoteAddress . |
UdpConnected.Connect$ |
|
UdpConnected.Connected$ |
|
UdpConnected.Disconnect$ |
Send this message to a connection actor (which had previously sent the
UdpConnected.Connected message) in order to close the socket. |
UdpConnected.Disconnected$ |
|
UdpConnected.NoAck |
Each UdpConnected.Send can optionally request a positive acknowledgment to be sent
to the commanding actor. |
UdpConnected.NoAck$ |
Default UdpConnected.NoAck instance which is used when no acknowledgment information is
explicitly provided. |
UdpConnected.Received |
When a connection actor receives a datagram from its socket it will send
it to the handler designated in the Udp.Bind message using this message type. |
UdpConnected.Received$ |
|
UdpConnected.ResumeReading$ |
This message must be sent to the listener actor to re-enable reading from
the socket after a SuspendReading command. |
UdpConnected.Send |
This message is understood by the connection actors to send data to their
designated destination. |
UdpConnected.Send$ |
|
UdpConnected.SuspendReading$ |
Send this message to a listener actor (which sent a Udp.Bound message) to
have it stop reading datagrams from the network. |
UdpConnected$ |
UDP Extension for Akka’s IO layer. |
UdpConnectedExt |
|
UdpConnectedMessage |
Java API: factory methods for the message types used when communicating with the UdpConnected service. |
UdpConnectedMessage$ |
Java API: factory methods for the message types used when communicating with the UdpConnected service. |
UdpExt |
|
UdpMessage |
Java API: factory methods for the message types used when communicating with the Udp service. |
UdpMessage$ |
Java API: factory methods for the message types used when communicating with the Udp service. |
UdpSO |
|
UdpSO$ |
|