akka.io.Tcp

Bind

case class Bind(handler: ActorRef, localAddress: InetSocketAddress, backlog: Int = 100, options: Traversable[SocketOption] = immutable.this.Nil) extends Command with Product with Serializable

The Bind message is send to the TCP manager actor, which is obtained via TcpExt#manager in order to bind to a listening socket. The manager replies either with a CommandFailed or the actor handling the listen socket replies with a Bound message. If the local port is set to 0 in the Bind message, then the Bound message should be inspected to find the actual port which was bound to.

handler

The actor which will receive all incoming connection requests in the form of Connected messages.

localAddress

The socket address to bind to; use port zero for automatic assignment (i.e. an ephemeral port, see Bound)

backlog

This specifies the number of unaccepted connections the O/S kernel will hold for this port before refusing connections.

options

Please refer to the SO object for a list of all supported options.

Linear Supertypes
Serializable, Serializable, Product, Equals, Command, HasFailureMessage, Message, NoSerializationVerificationNeeded, AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Bind
  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 any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Bind(handler: ActorRef, localAddress: InetSocketAddress, backlog: Int = 100, options: Traversable[SocketOption] = immutable.this.Nil)

    handler

    The actor which will receive all incoming connection requests in the form of Connected messages.

    localAddress

    The socket address to bind to; use port zero for automatic assignment (i.e. an ephemeral port, see Bound)

    backlog

    This specifies the number of unaccepted connections the O/S kernel will hold for this port before refusing connections.

    options

    Please refer to the SO object for a list of all supported options.

Value Members

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

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

    Definition Classes
    Any
  3. final def ##(): Int

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

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

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

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

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. val backlog: Int

    This specifies the number of unaccepted connections the O/S kernel will hold for this port before refusing connections.

  10. def clone(): AnyRef

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

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

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

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

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

    Definition Classes
    AnyRef
  16. def failureMessage: CommandFailed

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

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

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

    Definition Classes
    AnyRef → Any
  20. val handler: ActorRef

    The actor which will receive all incoming connection requests in the form of Connected messages.

  21. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  22. val localAddress: InetSocketAddress

    The socket address to bind to; use port zero for automatic assignment (i.

    The socket address to bind to; use port zero for automatic assignment (i.e. an ephemeral port, see Bound)

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

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

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

    Definition Classes
    AnyRef
  26. val options: Traversable[SocketOption]

    Please refer to the SO object for a list of all supported options.

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

    Definition Classes
    AnyRef
  28. final def wait(): Unit

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

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

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

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

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from Bind to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (bind: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from Bind to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (bind: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: Bind

    Implicit information
    This member is added by an implicit conversion from Bind to ArrowAssoc[Bind] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (bind: ArrowAssoc[Bind]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Bind

    Implicit information
    This member is added by an implicit conversion from Bind to Ensuring[Bind] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (bind: Ensuring[Bind]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

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 Bind to StringAdd

Inherited by implicit conversion any2stringfmt from Bind to StringFormat

Inherited by implicit conversion any2ArrowAssoc from Bind to ArrowAssoc[Bind]

Inherited by implicit conversion any2Ensuring from Bind to Ensuring[Bind]

Ungrouped