Bind

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

Instance Constructors

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

final def !=(arg0: Any): Boolean

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

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

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

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

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

Definition Classes
Any
val backlog: Int

This specifies the number of unaccepted connections the O/S kernel will hold for this port before refusing connections.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @throws( ... )
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 Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (Bind) ⇒ Boolean): Bind

Implicit information
This member is added by an implicit conversion from Bind to Ensuring[Bind] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
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 Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): Bind

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

Definition Classes
AnyRef
def failureMessage: CommandFailed

Definition Classes
Command → HasFailureMessage
def formatted(fmtstr: String): String

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

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
val handler: ActorRef

The actor which will receive all incoming connection requests in the form of Connected messages.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val localAddress: InetSocketAddress

The socket address to bind to; use port zero for automatic assignment (i.e.
The socket address to bind to; use port zero for automatic assignment (i.e. an ephemeral port, see Bound)
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
val options: Traversable[SocketOption]

Please refer to the Tcp.SO object for a list of all supported options.
val pullMode: Boolean
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
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( ... )
def →[B](y: B): (Bind, B)

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

Deprecated Value Members

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.

Related Doc: package Tcp

final case class Bind(handler: ActorRef, localAddress: InetSocketAddress, backlog: Int = 100, options: Traversable[SocketOption] = Nil, pullMode: Boolean = false) extends Command with Product with Serializable

Instance Constructors

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

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (Bind, B)

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val backlog: Int

def clone(): AnyRef

def ensuring(cond: (Bind) ⇒ Boolean, msg: ⇒ Any): Bind

def ensuring(cond: (Bind) ⇒ Boolean): Bind

def ensuring(cond: Boolean, msg: ⇒ Any): Bind

def ensuring(cond: Boolean): Bind

final def eq(arg0: AnyRef): Boolean

def failureMessage: CommandFailed

def formatted(fmtstr: String): String

final def getClass(): Class[_]

val handler: ActorRef

final def isInstanceOf[T0]: Boolean

val localAddress: InetSocketAddress

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val options: Traversable[SocketOption]

val pullMode: Boolean

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

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def →[B](y: B): (Bind, B)

Deprecated Value Members

def finalize(): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Command

Inherited from HasFailureMessage

Inherited from Message

Inherited from NoSerializationVerificationNeeded

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped