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.
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. The sender of this command and the registered handler for
incoming data will both be notified once the socket is closed using a
Tcp.Aborted
message.
Open a listening socket without specifying options.
The Bind message is send to the TCP manager actor, which is obtained via TcpExt#getManager in order to bind to a listening socket.
The Bind message is send to the TCP manager actor, which is obtained via TcpExt#getManager in order to bind to a listening socket. The manager replies either with a Tcp.CommandFailed or the actor handling the listen socket replies with a Tcp.Bound message. If the local port is set to 0 in the Bind message, then the Tcp.Bound message should be inspected to find the actual port which was bound to.
The actor which will receive all incoming connection requests in the form of Tcp.Connected messages.
The socket address to bind to; use port zero for automatic assignment (i.e. an ephemeral port, see Tcp.Bound)
This specifies the number of unaccepted connections the O/S kernel will hold for this port before refusing connections.
Please refer to TcpSO for a list of all supported options.
enables pull based accepting and of connections and pull based reading from the accepted connections.
A normal close operation will first flush pending writes and then close the socket.
A normal close operation will first flush pending writes and then close the
socket. The sender of this command and the registered handler for incoming
data will both be notified once the socket is closed using a Tcp.Closed
message.
A confirmed close operation will flush pending writes and half-close the connection, waiting for the peer to close the other half.
A confirmed close operation will flush pending writes and half-close the
connection, waiting for the peer to close the other half. The sender of this
command and the registered handler for incoming data will both be notified
once the socket is closed using a Tcp.ConfirmedClosed
message.
Connect to the given remoteAddress
without binding to a local address and without
specifying options.
The Connect message is sent to the TCP manager actor, which is obtained via TcpExt#getManager.
The Connect message is sent to the TCP manager actor, which is obtained via TcpExt#getManager. Either the manager replies with a Tcp.CommandFailed or the actor handling the new connection replies with a Tcp.Connected message.
is the address to connect to
optionally specifies a specific address to bind to
Please refer to TcpSO for a list of all supported options.
is the desired connection timeout, null
means "no timeout"
enables pull based reading from the connection
Default Tcp.NoAck instance which is used when no acknowledgment information is explicitly provided.
Default Tcp.NoAck instance which is used when no acknowledgment information is
explicitly provided. Its “token” is null
.
Each Tcp.WriteCommand can optionally request a positive acknowledgment to be sent to the commanding actor.
Each Tcp.WriteCommand can optionally request a positive acknowledgment to be sent to the commanding actor. If such notification is not desired the Tcp.SimpleWriteCommand#ack must be set to an instance of this class. The token contained within can be used to recognize which write failed when receiving a Tcp.CommandFailed message.
The same as register(handler, false, false)
.
This message must be sent to a TCP connection actor after receiving the Tcp.Connected message.
This message must be sent to a TCP connection actor after receiving the Tcp.Connected message. The connection will not read any data from the socket until this message is received, because this message defines the actor which will receive all inbound data.
The actor which will receive all incoming data and which will be informed when the connection is closed.
If this is set to true then the connection
is not automatically closed when the peer closes its half,
requiring an explicit Tcp.ConnectionClosed from our side when finished.
If this is set to true then the connection actor
will refuse all further writes after issuing a Tcp.CommandFailed
notification until Tcp ResumeWriting
is received. This can
be used to implement NACK-based write backpressure.
This message enables the accepting of the next connection if pull reading is enabled for connection actors.
This message enables the accepting of the next connection if pull reading is enabled for connection actors.
The number of connections to accept before waiting for the next resume command
This command needs to be sent to the connection actor after a Tcp.SuspendReading
command in order to resume reading from the socket.
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.
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. All Tcp.WriteCommand processed by the
connection actor between the first Tcp.CommandFailed and subsequent reception of
this message will also be rejected with Tcp.CommandFailed.
Sending this command to the connection actor will disable reading from the TCP socket.
Sending this command to the connection actor will disable reading from the TCP
socket. TCP flow-control will then propagate backpressure to the sender side
as buffers fill up on either end. To re-enable reading send Tcp.ResumeReading
.
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).
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). The
listener socket actor will reply with a Tcp.Unbound
message.
The same as write(data, noAck())
.
Write data to the TCP connection.
Write data to the TCP connection. If no ack is needed use the special
NoAck
object. The connection actor will reply with a Tcp.CommandFailed
message if the write could not be enqueued. If Tcp.SimpleWriteCommand#wantsAck
returns true, the connection actor will reply with the supplied Tcp.SimpleWriteCommand#ack
token once the write has been successfully enqueued to the O/S kernel.
Note that this does not in any way guarantee that the data will be
or have been sent! Unfortunately there is no way to determine whether
a particular write has been sent by the O/S.
Write count
bytes starting at position
from file at filePath
to the connection.
Write count
bytes starting at position
from file at filePath
to the connection.
The count must be > 0. The connection actor will reply with a Tcp.CommandFailed
message if the write could not be enqueued. If Tcp.SimpleWriteCommand#wantsAck
returns true, the connection actor will reply with the supplied Tcp.SimpleWriteCommand#ack
token once the write has been successfully enqueued to the O/S kernel.
Note that this does not in any way guarantee that the data will be
or have been sent! Unfortunately there is no way to determine whether
a particular write has been sent by the O/S.