Packages

final class Tcp extends Extension

Source
Tcp.scala
Linear Supertypes
Extension, AnyRef, Any
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. def bind(interface: String, port: Int, backlog: Int = 100, options: Traversable[SocketOption] = Nil, halfClose: Boolean = false, idleTimeout: Duration = Duration.Inf): Source[IncomingConnection, Future[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.

  2. def bindAndHandle(handler: Flow[ByteString, ByteString, _], interface: String, port: Int, backlog: Int = 100, options: Traversable[SocketOption] = Nil, halfClose: Boolean = false, idleTimeout: Duration = Duration.Inf)(implicit m: Materializer): Future[ServerBinding]

    Creates a Tcp.ServerBinding instance which represents a prospective TCP server binding on the given endpoint handling the incoming connections using the provided Flow.

    Creates a Tcp.ServerBinding instance which represents a prospective TCP server binding on the given endpoint handling the incoming connections using the provided Flow.

    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 returned future completes is the server ready to accept client connections.

    handler

    A Flow that represents the server logic

    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.

  3. def bindAndHandleTls(handler: Flow[ByteString, ByteString, _], interface: String, port: Int, sslContext: SSLContext, negotiateNewSession: NegotiateNewSession, backlog: Int = 100, options: Traversable[SocketOption] = Nil, idleTimeout: Duration = Duration.Inf)(implicit m: Materializer): Future[ServerBinding]

    Creates a Tcp.ServerBinding instance which represents a prospective TCP server binding on the given endpoint handling the incoming connections through TLS and then run using the provided Flow.

    Creates a Tcp.ServerBinding instance which represents a prospective TCP server binding on the given endpoint handling the incoming connections through TLS and then run using the provided Flow.

    sslContext

    Context containing details such as the trust and keystore

    negotiateNewSession

    Details about what to require when negotiating the connection with the server

    Annotations
    @ApiMayChange()
    See also

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

  4. val bindShutdownTimeout: FiniteDuration
  5. def bindTls(interface: String, port: Int, sslContext: SSLContext, negotiateNewSession: NegotiateNewSession, backlog: Int = 100, options: Traversable[SocketOption] = Nil, idleTimeout: Duration = Duration.Inf): Source[IncomingConnection, Future[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.

    sslContext

    Context containing details such as the trust and keystore

    negotiateNewSession

    Details about what to require when negotiating the connection with the server

    Annotations
    @ApiMayChange()
    See also

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

  6. def outgoingConnection(host: String, port: Int): Flow[ByteString, ByteString, Future[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.

  7. def outgoingConnection(remoteAddress: InetSocketAddress, localAddress: Option[InetSocketAddress] = None, options: Traversable[SocketOption] = Nil, halfClose: Boolean = true, connectTimeout: Duration = Duration.Inf, idleTimeout: Duration = Duration.Inf): Flow[ByteString, ByteString, Future[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.

  8. def outgoingTlsConnection(remoteAddress: InetSocketAddress, sslContext: SSLContext, negotiateNewSession: NegotiateNewSession, localAddress: Option[InetSocketAddress] = None, options: Traversable[SocketOption] = Nil, connectTimeout: Duration = Duration.Inf, idleTimeout: Duration = Duration.Inf): Flow[ByteString, ByteString, Future[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.

    sslContext

    Context containing details such as the trust and keystore Marked API-may-change to leave room for an improvement around the very long parameter list.

    negotiateNewSession

    Details about what to require when negotiating the connection with the server

    Annotations
    @ApiMayChange()
    See also

    Tcp.outgoingConnection()

  9. def outgoingTlsConnection(host: String, port: Int, sslContext: SSLContext, negotiateNewSession: NegotiateNewSession): Flow[ByteString, ByteString, Future[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.

    For more advanced use cases you can manually combine Tcp.outgoingConnection() and TLS

    sslContext

    Context containing details such as the trust and keystore

    negotiateNewSession

    Details about what to require when negotiating the connection with the server

    See also

    Tcp.outgoingConnection()