final case class Register(handler: ActorRef, keepOpenOnPeerClosed: Boolean = false, useResumeWriting: Boolean = true) extends Command with Product with Serializable
This message must be sent to a TCP connection actor after receiving the 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.
- handler
The actor which will receive all incoming data and which will be informed when the connection is closed.
- keepOpenOnPeerClosed
If this is set to true then the connection is not automatically closed when the peer closes its half, requiring an explicit CloseCommand from our side when finished.
- useResumeWriting
If this is set to true then the connection actor will refuse all further writes after issuing a CommandFailed notification until
ResumeWriting
is received. This can be used to implement NACK-based write backpressure.
- Source
- Tcp.scala
- Alphabetic
- By Inheritance
- Register
- Serializable
- Serializable
- Product
- Equals
- Command
- HasFailureMessage
- Message
- NoSerializationVerificationNeeded
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
Register(handler: ActorRef, keepOpenOnPeerClosed: Boolean = false, useResumeWriting: Boolean = true)
- handler
The actor which will receive all incoming data and which will be informed when the connection is closed.
- keepOpenOnPeerClosed
If this is set to true then the connection is not automatically closed when the peer closes its half, requiring an explicit CloseCommand from our side when finished.
- useResumeWriting
If this is set to true then the connection actor will refuse all further writes after issuing a CommandFailed notification until
ResumeWriting
is received. This can be used to implement NACK-based write backpressure.
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Register, B)
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
- def ensuring(cond: (Register) ⇒ Boolean, msg: ⇒ Any): Register
- def ensuring(cond: (Register) ⇒ Boolean): Register
- def ensuring(cond: Boolean, msg: ⇒ Any): Register
- def ensuring(cond: Boolean): Register
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
failureMessage: CommandFailed
- Definition Classes
- Command → HasFailureMessage
- def formatted(fmtstr: String): String
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val handler: ActorRef
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val keepOpenOnPeerClosed: Boolean
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
- val useResumeWriting: Boolean
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- def →[B](y: B): (Register, B)