class Tcp extends Extension

Source
Tcp.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Tcp
  2. Extension
  3. AnyRef
  4. 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 Tcp(system: ExtendedActorSystem)

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 Tcp toany2stringadd[Tcp] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Tcp, B)
    Implicit
    This member is added by an implicit conversion from Tcp toArrowAssoc[Tcp] 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 bind(interface: String, port: Int): Source[IncomingConnection, CompletionStage[ServerBinding]]

    Creates a Tcp.ServerBinding without specifying options.

    Creates a Tcp.ServerBinding without specifying options. It represents a prospective TCP server binding on the given endpoint.

    Please note that the startup of the server is asynchronous, i.e. after materializing the enclosing akka.stream.scaladsl.RunnableGraph the server is not immediately available. Only after the materialized future completes is the server ready to accept client connections.

  8. def bind(interface: String, port: Int, backlog: Int, options: Iterable[SocketOption], halfClose: Boolean, idleTimeout: Optional[Duration]): Source[IncomingConnection, CompletionStage[ServerBinding]]

    Creates a Tcp.ServerBinding instance which represents a prospective TCP server binding on the given endpoint.

    Creates a Tcp.ServerBinding instance which represents a prospective TCP server binding on the given endpoint.

    Please note that the startup of the server is asynchronous, i.e. after materializing the enclosing akka.stream.scaladsl.RunnableGraph the server is not immediately available. Only after the materialized future completes is the server ready to accept client connections.

    interface

    The interface to listen on

    port

    The port to listen on

    backlog

    Controls the size of the connection backlog

    options

    TCP options for the connections, see akka.io.Tcp for details

    halfClose

    Controls whether the connection is kept open even after writing has been completed to the accepted TCP connections. If set to true, the connection will implement the TCP half-close mechanism, allowing the client to write to the connection even after the server has finished writing. The TCP socket is only closed after both the client and server finished writing. If set to false, the connection will immediately closed once the server closes its write side, independently whether the client is still attempting to write. This setting is recommended for servers, and therefore it is the default setting.

  9. def bindWithTls(interface: String, port: Int, createSSLEngine: Supplier[SSLEngine], backlog: Int, options: Iterable[SocketOption], idleTimeout: Optional[Duration], verifySession: Function[SSLSession, Optional[Throwable]], closing: TLSClosing): Source[IncomingConnection, CompletionStage[ServerBinding]]

    Creates a Tcp.ServerBinding instance which represents a prospective TCP server binding on the given endpoint where all incoming and outgoing bytes are passed through TLS.

    Creates a Tcp.ServerBinding instance which represents a prospective TCP server binding on the given endpoint where all incoming and outgoing bytes are passed through TLS.

    See also

    Tcp.bind

  10. def bindWithTls(interface: String, port: Int, createSSLEngine: Supplier[SSLEngine]): Source[IncomingConnection, CompletionStage[ServerBinding]]

    Creates a Tcp.ServerBinding instance which represents a prospective TCP server binding on the given endpoint where all incoming and outgoing bytes are passed through TLS.

    Creates a Tcp.ServerBinding instance which represents a prospective TCP server binding on the given endpoint where all incoming and outgoing bytes are passed through TLS.

    See also

    Tcp.bind

  11. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  12. def ensuring(cond: (Tcp) => Boolean, msg: => Any): Tcp
    Implicit
    This member is added by an implicit conversion from Tcp toEnsuring[Tcp] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (Tcp) => Boolean): Tcp
    Implicit
    This member is added by an implicit conversion from Tcp toEnsuring[Tcp] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: => Any): Tcp
    Implicit
    This member is added by an implicit conversion from Tcp toEnsuring[Tcp] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): Tcp
    Implicit
    This member is added by an implicit conversion from Tcp toEnsuring[Tcp] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  18. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Tcp toStringFormat[Tcp] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. def outgoingConnection(host: String, port: Int): Flow[ByteString, ByteString, CompletionStage[OutgoingConnection]]

    Creates an Tcp.OutgoingConnection without specifying options.

    Creates an Tcp.OutgoingConnection without specifying options. It represents a prospective TCP client connection to the given endpoint.

    Note that the ByteString chunk boundaries are not retained across the network, to achieve application level chunks you have to introduce explicit framing in your streams, for example using the Framing operators.

  26. def outgoingConnection(remoteAddress: InetSocketAddress, localAddress: Optional[InetSocketAddress], options: Iterable[SocketOption], halfClose: Boolean, connectTimeout: Optional[Duration], idleTimeout: Optional[Duration]): Flow[ByteString, ByteString, CompletionStage[OutgoingConnection]]

    Creates an Tcp.OutgoingConnection instance representing a prospective TCP client connection to the given endpoint.

    Creates an Tcp.OutgoingConnection instance representing a prospective TCP client connection to the given endpoint.

    Note that the ByteString chunk boundaries are not retained across the network, to achieve application level chunks you have to introduce explicit framing in your streams, for example using the Framing operators.

    remoteAddress

    The remote address to connect to

    localAddress

    Optional local address for the connection

    options

    TCP options for the connections, see akka.io.Tcp for details

    halfClose

    Controls whether the connection is kept open even after writing has been completed to the accepted TCP connections. If set to true, the connection will implement the TCP half-close mechanism, allowing the server to write to the connection even after the client has finished writing. The TCP socket is only closed after both the client and server finished writing. This setting is recommended for clients and therefore it is the default setting. If set to false, the connection will immediately closed once the client closes its write side, independently whether the server is still attempting to write.

  27. def outgoingConnectionWithTls(remoteAddress: InetSocketAddress, createSSLEngine: Supplier[SSLEngine], localAddress: Optional[InetSocketAddress], options: Iterable[SocketOption], connectTimeout: Optional[Duration], idleTimeout: Optional[Duration], verifySession: Function[SSLSession, Optional[Throwable]], closing: TLSClosing): Flow[ByteString, ByteString, CompletionStage[OutgoingConnection]]

    Creates an Tcp.OutgoingConnection with TLS.

    Creates an Tcp.OutgoingConnection with TLS. The returned flow represents a TCP client connection to the given endpoint where all bytes in and out go through TLS.

    You specify a factory to create an SSLEngine that must already be configured for client mode and with all the parameters for the first session.

    See also

    Tcp.outgoingConnection

  28. def outgoingConnectionWithTls(remoteAddress: InetSocketAddress, createSSLEngine: Supplier[SSLEngine]): Flow[ByteString, ByteString, CompletionStage[OutgoingConnection]]

    Creates an Tcp.OutgoingConnection with TLS.

    Creates an Tcp.OutgoingConnection with TLS. The returned flow represents a TCP client connection to the given endpoint where all bytes in and out go through TLS.

    You specify a factory to create an SSLEngine that must already be configured for client mode and with all the parameters for the first session.

    See also

    Tcp.outgoingConnection

  29. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def bind(interface: String, port: Int, backlog: Int, options: Iterable[SocketOption], halfClose: Boolean, idleTimeout: Duration): Source[IncomingConnection, CompletionStage[ServerBinding]]

    Creates a Tcp.ServerBinding instance which represents a prospective TCP server binding on the given endpoint.

    Creates a Tcp.ServerBinding instance which represents a prospective TCP server binding on the given endpoint.

    Please note that the startup of the server is asynchronous, i.e. after materializing the enclosing akka.stream.scaladsl.RunnableGraph the server is not immediately available. Only after the materialized future completes is the server ready to accept client connections.

    interface

    The interface to listen on

    port

    The port to listen on

    backlog

    Controls the size of the connection backlog

    options

    TCP options for the connections, see akka.io.Tcp for details

    halfClose

    Controls whether the connection is kept open even after writing has been completed to the accepted TCP connections. If set to true, the connection will implement the TCP half-close mechanism, allowing the client to write to the connection even after the server has finished writing. The TCP socket is only closed after both the client and server finished writing. If set to false, the connection will immediately closed once the server closes its write side, independently whether the client is still attempting to write. This setting is recommended for servers, and therefore it is the default setting.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use bind that takes a java.time.Duration parameter instead.

  2. def bindTls(interface: String, port: Int, sslContext: SSLContext, negotiateNewSession: NegotiateNewSession): Source[IncomingConnection, CompletionStage[ServerBinding]]

    Creates a Tcp.ServerBinding instance which represents a prospective TCP server binding on the given endpoint where all incoming and outgoing bytes are passed through TLS.

    Creates a Tcp.ServerBinding instance which represents a prospective TCP server binding on the given endpoint where all incoming and outgoing bytes are passed through TLS.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0)

    See also

    Tcp.bind

  3. def bindTls(interface: String, port: Int, sslContext: SSLContext, negotiateNewSession: NegotiateNewSession, backlog: Int, options: Iterable[SocketOption], halfClose: Boolean, idleTimeout: Duration): Source[IncomingConnection, CompletionStage[ServerBinding]]

    Creates a Tcp.ServerBinding instance which represents a prospective TCP server binding on the given endpoint where all incoming and outgoing bytes are passed through TLS.

    Creates a Tcp.ServerBinding instance which represents a prospective TCP server binding on the given endpoint where all incoming and outgoing bytes are passed through TLS.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0)

    See also

    Tcp.bind Marked API-may-change to leave room for an improvement around the very long parameter list. Note: the half close parameter is currently ignored

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

  5. def outgoingConnection(remoteAddress: InetSocketAddress, localAddress: Optional[InetSocketAddress], options: Iterable[SocketOption], halfClose: Boolean, connectTimeout: Duration, idleTimeout: Duration): Flow[ByteString, ByteString, CompletionStage[OutgoingConnection]]

    Creates an Tcp.OutgoingConnection instance representing a prospective TCP client connection to the given endpoint.

    Creates an Tcp.OutgoingConnection instance representing a prospective TCP client connection to the given endpoint.

    Note that the ByteString chunk boundaries are not retained across the network, to achieve application level chunks you have to introduce explicit framing in your streams, for example using the Framing operators.

    remoteAddress

    The remote address to connect to

    localAddress

    Optional local address for the connection

    options

    TCP options for the connections, see akka.io.Tcp for details

    halfClose

    Controls whether the connection is kept open even after writing has been completed to the accepted TCP connections. If set to true, the connection will implement the TCP half-close mechanism, allowing the server to write to the connection even after the client has finished writing. The TCP socket is only closed after both the client and server finished writing. This setting is recommended for clients and therefore it is the default setting. If set to false, the connection will immediately closed once the client closes its write side, independently whether the server is still attempting to write.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use bind that takes a java.time.Duration parameter instead.

  6. def outgoingTlsConnection(remoteAddress: InetSocketAddress, sslContext: SSLContext, negotiateNewSession: NegotiateNewSession, localAddress: Optional[InetSocketAddress], options: Iterable[SocketOption], connectTimeout: Duration, idleTimeout: Duration): Flow[ByteString, ByteString, CompletionStage[OutgoingConnection]]

    Creates an Tcp.OutgoingConnection with TLS.

    Creates an Tcp.OutgoingConnection with TLS. The returned flow represents a TCP client connection to the given endpoint where all bytes in and out go through TLS.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0)

    See also

    Tcp.outgoingConnection Marked API-may-change to leave room for an improvement around the very long parameter list.

  7. def outgoingTlsConnection(host: String, port: Int, sslContext: SSLContext, negotiateNewSession: NegotiateNewSession): Flow[ByteString, ByteString, CompletionStage[OutgoingConnection]]

    Creates an Tcp.OutgoingConnection with TLS.

    Creates an Tcp.OutgoingConnection with TLS. The returned flow represents a TCP client connection to the given endpoint where all bytes in and out go through TLS.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0)

    See also

    Tcp.outgoingConnection

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

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromTcp to any2stringadd[Tcp]

Inherited by implicit conversion StringFormat fromTcp to StringFormat[Tcp]

Inherited by implicit conversion Ensuring fromTcp to Ensuring[Tcp]

Inherited by implicit conversion ArrowAssoc fromTcp to ArrowAssoc[Tcp]

Ungrouped