Bind

org.apache.pekko.io.Tcp.Bind
final case class Bind(handler: ActorRef, localAddress: InetSocketAddress, backlog: Int = ..., options: Iterable[SocketOption] = ..., pullMode: Boolean = ...) extends Command

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.

Value parameters

backlog

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

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)

options

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

Attributes

Source
Tcp.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Command
trait HasFailureMessage
trait Message
class Object
trait Matchable
class Any
Show all

Members list

Value members

Inherited methods

def failureMessage: Any

Attributes

Inherited from:
Command
Source
Tcp.scala

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product