Packages

c

akka.io.Tcp

Bind

final case class Bind(handler: ActorRef, localAddress: InetSocketAddress, backlog: Int = 100, options: Traversable[SocketOption] = Nil, pullMode: Boolean = false) 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 Tcp.SO object for a list of all supported options.

Source
Tcp.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, Command, HasFailureMessage, Message, NoSerializationVerificationNeeded, AnyRef, Any
Type Hierarchy
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 StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

    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 Tcp.SO object for a list of all supported options.

Value Members

  1. val backlog: Int
  2. def failureMessage: CommandFailed
    Definition Classes
    Command → HasFailureMessage
  3. val handler: ActorRef
  4. val localAddress: InetSocketAddress
  5. val options: Traversable[SocketOption]
  6. val pullMode: Boolean