org.apache.pekko.stream.connectors.unixdomainsocket.javadsl
UnixDomainSocket
Companion object UnixDomainSocket
final class UnixDomainSocket extends Extension
- Source
- UnixDomainSocket.scala
- Alphabetic
- By Inheritance
- UnixDomainSocket
- Extension
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new UnixDomainSocket(system: ExtendedActorSystem)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def bind(path: Path): Source[IncomingConnection, CompletionStage[ServerBinding]]
Creates a UnixDomainSocket.ServerBinding without specifying options.
Creates a UnixDomainSocket.ServerBinding without specifying options. It represents a prospective UnixDomainSocket 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(path: Path, backlog: Int, halfClose: Boolean): Source[IncomingConnection, CompletionStage[ServerBinding]]
Creates a UnixDomainSocket.ServerBinding instance which represents a prospective UnixDomainSocket server binding on the given
endpoint
.Creates a UnixDomainSocket.ServerBinding instance which represents a prospective UnixDomainSocket 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.
TODO: Support idleTimeout as per Tcp.
- path
The path to listen on
- backlog
Controls the size of the connection backlog
- halfClose
Controls whether the connection is kept open even after writing has been completed to the accepted UnixDomainSocket connections. If set to true, the connection will implement the UnixDomainSocket half-close mechanism, allowing the client to write to the connection even after the server has finished writing. The UnixDomainSocket 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 clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @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
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def outgoingConnection(path: Path): Flow[ByteString, ByteString, CompletionStage[OutgoingConnection]]
Creates an UnixDomainSocket.OutgoingConnection without specifying options.
Creates an UnixDomainSocket.OutgoingConnection without specifying options. It represents a prospective UnixDomainSocket client connection to the given endpoint.
TODO: Support idleTimeout as per Tcp.
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 pekko.stream.javadsl.Framing stages.
- def outgoingConnection(remoteAddress: UnixSocketAddress, localAddress: Optional[UnixSocketAddress], halfClose: Boolean, connectTimeout: Duration): Flow[ByteString, ByteString, CompletionStage[OutgoingConnection]]
Creates an UnixDomainSocket.OutgoingConnection instance representing a prospective UnixDomainSocket client connection to the given endpoint.
Creates an UnixDomainSocket.OutgoingConnection instance representing a prospective UnixDomainSocket 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 pekko.stream.javadsl.Framing stages.
TODO: Support idleTimeout as per Tcp.
- remoteAddress
The remote address to connect to
- localAddress
Optional local address for the connection
- halfClose
Controls whether the connection is kept open even after writing has been completed to the accepted UnixDomainSocket connections. If set to true, the connection will implement the UnixDomainSocket half-close mechanism, allowing the server to write to the connection even after the client has finished writing. The UnixDomainSocket 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.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- 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()