Packages

c

akka.io.Tcp

Connect

final case class Connect(remoteAddress: InetSocketAddress, localAddress: Option[InetSocketAddress] = None, options: Traversable[SocketOption] = Nil, timeout: Option[FiniteDuration] = None, pullMode: Boolean = false) extends Command with Product with Serializable

The Connect message is sent to the TCP manager actor, which is obtained via TcpExt#manager. Either the manager replies with a CommandFailed or the actor handling the new connection replies with a Connected message.

remoteAddress

is the address to connect to

localAddress

optionally specifies a specific address to bind to

options

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

Annotations
@silent("deprecated")
Source
Tcp.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Connect
  2. Serializable
  3. Product
  4. Equals
  5. Command
  6. HasFailureMessage
  7. Message
  8. NoSerializationVerificationNeeded
  9. AnyRef
  10. 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 Connect(remoteAddress: InetSocketAddress, localAddress: Option[InetSocketAddress] = None, options: Traversable[SocketOption] = Nil, timeout: Option[FiniteDuration] = None, pullMode: Boolean = false)

    remoteAddress

    is the address to connect to

    localAddress

    optionally specifies a specific address to bind to

    options

    Please refer to the Tcp.SO object 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
    This member is added by an implicit conversion from Connect toany2stringadd[Connect] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Connect, B)
    Implicit
    This member is added by an implicit conversion from Connect toArrowAssoc[Connect] 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. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. def ensuring(cond: (Connect) => Boolean, msg: => Any): Connect
    Implicit
    This member is added by an implicit conversion from Connect toEnsuring[Connect] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (Connect) => Boolean): Connect
    Implicit
    This member is added by an implicit conversion from Connect toEnsuring[Connect] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): Connect
    Implicit
    This member is added by an implicit conversion from Connect toEnsuring[Connect] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): Connect
    Implicit
    This member is added by an implicit conversion from Connect toEnsuring[Connect] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def failureMessage: CommandFailed
    Definition Classes
    Command → HasFailureMessage
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Connect toStringFormat[Connect] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. val localAddress: Option[InetSocketAddress]
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. val options: Traversable[SocketOption]
  22. def productElementNames: Iterator[String]
    Definition Classes
    Product
  23. val pullMode: Boolean
  24. val remoteAddress: InetSocketAddress
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. val timeout: Option[FiniteDuration]
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  2. def [B](y: B): (Connect, B)
    Implicit
    This member is added by an implicit conversion from Connect toArrowAssoc[Connect] 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.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Command

Inherited from HasFailureMessage

Inherited from Message

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromConnect to any2stringadd[Connect]

Inherited by implicit conversion StringFormat fromConnect to StringFormat[Connect]

Inherited by implicit conversion Ensuring fromConnect to Ensuring[Connect]

Inherited by implicit conversion ArrowAssoc fromConnect to ArrowAssoc[Connect]

Ungrouped