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.
- Annotations
- @nowarn()
- Source
- Tcp.scala
- Alphabetic
- By Inheritance
- Bind
- Serializable
- Product
- Equals
- Command
- HasFailureMessage
- Message
- NoSerializationVerificationNeeded
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
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
- def ->[B](y: B): (Bind, B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val backlog: Int
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- 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
- Definition Classes
- AnyRef
- def failureMessage: CommandFailed
- Definition Classes
- Command → HasFailureMessage
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- val handler: ActorRef
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val localAddress: InetSocketAddress
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- val options: Traversable[SocketOption]
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val pullMode: Boolean
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from Bind toStringFormat[Bind] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- def →[B](y: B): (Bind, B)
- Implicit
- This member is added by an implicit conversion from Bind toArrowAssoc[Bind] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->
instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.