Register

This message must be sent to a TCP connection actor after receiving the akka.io.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.

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 akka.io.Tcp.Closed from our side when finished.
useResumeWriting: If this is set to true then the connection actor will refuse all further writes after issuing a akka.io.Tcp.CommandFailed notification until akka.io.Tcp.ResumeWriting is received. This can be used to implement NACK-based write backpressure.

Linear Supertypes

Serializable, Serializable, Product, Equals, Command, HasFailureMessage, Message, AnyRef, Any

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 akka.io.Tcp.Closed from our side when finished.
useResumeWriting
If this is set to true then the connection actor will refuse all further writes after issuing a akka.io.Tcp.CommandFailed notification until akka.io.Tcp.ResumeWriting is received. This can be used to implement NACK-based write backpressure.

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def failureMessage: CommandFailed

Definition Classes
Command → HasFailureMessage
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val handler: ActorRef

The actor which will receive all incoming data and which will be informed when the connection is closed.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val keepOpenOnPeerClosed: Boolean

If this is set to true then the connection is not automatically closed when the peer closes its half, requiring an explicit akka.io.Tcp.Closed from our side when finished.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val useResumeWriting: Boolean

If this is set to true then the connection actor will refuse all further writes after issuing a akka.io.Tcp.CommandFailed notification until akka.io.Tcp.ResumeWriting is received.
If this is set to true then the connection actor will refuse all further writes after issuing a akka.io.Tcp.CommandFailed notification until akka.io.Tcp.ResumeWriting is received. This can be used to implement NACK-based write backpressure.
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

case class Register(handler: ActorRef, keepOpenOnPeerClosed: Boolean = false, useResumeWriting: Boolean = true) extends Command with Product with Serializable

Instance Constructors

new Register(handler: ActorRef, keepOpenOnPeerClosed: Boolean = false, useResumeWriting: Boolean = true)

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def failureMessage: CommandFailed

def finalize(): Unit

final def getClass(): Class[_]

val handler: ActorRef

final def isInstanceOf[T0]: Boolean

val keepOpenOnPeerClosed: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

val useResumeWriting: Boolean

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Command

Inherited from HasFailureMessage

Inherited from Message

Inherited from AnyRef

Inherited from Any

Ungrouped