class Tcp extends Extension
- Alphabetic
- By Inheritance
- Tcp
- Extension
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Tcp(system: ExtendedActorSystem)
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): (Tcp, B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- 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 pekko.stream.scaladsl.RunnableGraph the server is not immediately available. Only after the materialized future completes is the server ready to accept client connections.
- 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 pekko.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 pekko.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.
- 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
endpointwhere all incoming and outgoing bytes are passed through TLS.Creates a Tcp.ServerBinding instance which represents a prospective TCP server binding on the given
endpointwhere all incoming and outgoing bytes are passed through TLS.- See also
- 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
endpointwhere all incoming and outgoing bytes are passed through TLS.Creates a Tcp.ServerBinding instance which represents a prospective TCP server binding on the given
endpointwhere all incoming and outgoing bytes are passed through TLS.- See also
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- def ensuring(cond: (Tcp) => Boolean, msg: => Any): Tcp
- def ensuring(cond: (Tcp) => Boolean): Tcp
- def ensuring(cond: Boolean, msg: => Any): Tcp
- def ensuring(cond: Boolean): Tcp
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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()
- 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.
- 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 pekko.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.
- 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
- 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
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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 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 pekko.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 pekko.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 Akka 2.6.0) Use bind that takes a java.time.Duration parameter instead.
- 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
endpointwhere all incoming and outgoing bytes are passed through TLS.Creates a Tcp.ServerBinding instance which represents a prospective TCP server binding on the given
endpointwhere all incoming and outgoing bytes are passed through TLS.- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.6.0) Use bindWithTls that takes a SSLEngine factory instead. Setup the SSLEngine with needed parameters.
- See also
- 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
endpointwhere all incoming and outgoing bytes are passed through TLS.Creates a Tcp.ServerBinding instance which represents a prospective TCP server binding on the given
endpointwhere all incoming and outgoing bytes are passed through TLS.- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.6.0) Use bindWithTls that takes a SSLEngine factory instead. Setup the SSLEngine with needed parameters.
- 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
- 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 Tcp toStringFormat[Tcp] 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,formattedresolves to the new method in String which has reversed parameters.
- 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 pekko.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 Akka 2.6.0) Use bind that takes a java.time.Duration parameter instead.
- 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 Akka 2.6.0) Use outgoingConnectionWithTls that takes a SSLEngine factory instead. Setup the SSLEngine with needed parameters.
- See also
Tcp.outgoingConnection Marked API-may-change to leave room for an improvement around the very long parameter list.
- 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 Akka 2.6.0) Use outgoingConnectionWithTls that takes a SSLEngine factory instead. Setup the SSLEngine with needed parameters.
- See also
- 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.