akka.stream.io.StreamTcp

Bind

case class Bind(settings: MaterializerSettings, localAddress: InetSocketAddress, backlog: Int = 100, options: Traversable[SocketOption] = Nil) extends Product with Serializable

The Bind message is send to the StreamTcp manager actor, which is obtained via IO(StreamTcp), in order to bind to a listening socket. The manager replies with a StreamTcp.TcpServerBinding. If the local port is set to 0 in the Bind message, then the StreamTcp.TcpServerBinding message should be inspected to find the actual port which was bound to.

localAddress

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

backlog

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

options

Please refer to akka.io.TcpSO for a list of all supported options.

Source
StreamIO.scala
Linear Supertypes
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. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Bind(settings: MaterializerSettings, localAddress: InetSocketAddress, backlog: Int = 100, options: Traversable[SocketOption] = Nil)

    localAddress

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

    backlog

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

    options

    Please refer to akka.io.TcpSO for a list of all supported options.

Value Members

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

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

    Definition Classes
    AnyRef → Any
  3. 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
  4. 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()
  5. final def ==(arg0: Any): Boolean

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

    Definition Classes
    Any
  7. val backlog: Int

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

  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. 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
  10. 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
  11. 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
  12. 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
  13. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  14. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. 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()
  16. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  17. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  18. 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)

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

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

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

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

    Please refer to akka.io.TcpSO for a list of all supported options.

  23. val settings: MaterializerSettings

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

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. def withBacklog(backlog: Int): Bind

    Java API

  29. def withSocketOptions(options: Iterable[SocketOption]): Bind

    Java API

  30. 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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

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