akka.io
Class Tcp.Register
java.lang.Object
akka.io.Tcp.Register
- All Implemented Interfaces:
- NoSerializationVerificationNeeded, SelectionHandler.HasFailureMessage, Tcp.Command, Tcp.Message, java.io.Serializable, scala.Equals, scala.Product
- Enclosing class:
- Tcp
public static class Tcp.Register
- extends java.lang.Object
- implements Tcp.Command, scala.Product, scala.Serializable
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.
param: handler The actor which will receive all incoming data and which
will be informed when the connection is closed.
param: keepOpenOnPeerClosed If this is set to true then the connection
is not automatically closed when the peer closes its half,
requiring an explicit Tcp.ErrorClosed
from our side when finished.
param: useResumeWriting If this is set to true then the connection actor
will refuse all further writes after issuing a Tcp.CommandFailed
notification until ResumeWriting
is received. This can
be used to implement NACK-based write backpressure.
- See Also:
- Serialized Form
Constructor Summary |
Tcp.Register(ActorRef handler,
boolean keepOpenOnPeerClosed,
boolean useResumeWriting)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface scala.Product |
productArity, productElement, productIterator, productPrefix |
Methods inherited from interface scala.Equals |
canEqual, equals |
Tcp.Register
public Tcp.Register(ActorRef handler,
boolean keepOpenOnPeerClosed,
boolean useResumeWriting)
handler
public ActorRef handler()
keepOpenOnPeerClosed
public boolean keepOpenOnPeerClosed()
useResumeWriting
public boolean useResumeWriting()