akka.io.Tcp

Register

Related Doc: package Tcp

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 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 CommandFailed notification until ResumeWriting is received. This can be used to implement NACK-based write backpressure.

Source
Tcp.scala
Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Register
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Command
  7. HasFailureMessage
  8. Message
  9. NoSerializationVerificationNeeded
  10. AnyRef
  11. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. 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 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 CommandFailed notification until ResumeWriting is received. This can be used to implement NACK-based write backpressure.

Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Register to any2stringadd[Register] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Register, B)

    Implicit information
    This member is added by an implicit conversion from Register to ArrowAssoc[Register] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def ensuring(cond: (Register) ⇒ Boolean, msg: ⇒ Any): Register

    Implicit information
    This member is added by an implicit conversion from Register to Ensuring[Register] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (Register) ⇒ Boolean): Register

    Implicit information
    This member is added by an implicit conversion from Register to Ensuring[Register] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): Register

    Implicit information
    This member is added by an implicit conversion from Register to Ensuring[Register] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): Register

    Implicit information
    This member is added by an implicit conversion from Register to Ensuring[Register] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  13. def failureMessage: CommandFailed

    Definition Classes
    Command → HasFailureMessage
  14. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Register to StringFormat[Register] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  17. val handler: ActorRef

    The actor which will receive all incoming data and which will be informed when the connection is closed.

  18. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  19. 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 Closed from our side when finished.

  20. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

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

    Definition Classes
    AnyRef
  24. val useResumeWriting: Boolean

    If this is set to true then the connection actor will refuse all further writes after issuing a CommandFailed notification until ResumeWriting is received.

    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.

  25. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. def [B](y: B): (Register, B)

    Implicit information
    This member is added by an implicit conversion from Register to ArrowAssoc[Register] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

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

Inherited by implicit conversion any2stringadd from Register to any2stringadd[Register]

Inherited by implicit conversion StringFormat from Register to StringFormat[Register]

Inherited by implicit conversion Ensuring from Register to Ensuring[Register]

Inherited by implicit conversion ArrowAssoc from Register to ArrowAssoc[Register]

Ungrouped