final class SocketGroup extends AnyRef
Resource that provides the ability to open client and server TCP sockets that all share an underlying non-blocking channel group.
- Source
- SocketGroup.scala
- Alphabetic
- By Inheritance
- SocketGroup
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new SocketGroup(channelGroup: AsynchronousChannelGroup, blocker: Blocker)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from SocketGroup toany2stringadd[SocketGroup] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (SocketGroup, B)
- Implicit
- This member is added by an implicit conversion from SocketGroup toArrowAssoc[SocketGroup] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def client[F[_]](to: InetSocketAddress, reuseAddress: Boolean = true, sendBufferSize: Int = 256 * 1024, receiveBufferSize: Int = 256 * 1024, keepAlive: Boolean = false, noDelay: Boolean = false, additionalSocketOptions: List[SocketOptionMapping[_]] = List.empty)(implicit F: Concurrent[F], CS: ContextShift[F]): Resource[F, Socket[F]]
Opens a connection to the specified server represented as a Socket.
Opens a connection to the specified server represented as a Socket. The connection is closed when the resource is released.
- to
address of remote server
- reuseAddress
whether address may be reused (see
java.net.StandardSocketOptions.SO_REUSEADDR)- sendBufferSize
size of send buffer (see
java.net.StandardSocketOptions.SO_SNDBUF)- receiveBufferSize
size of receive buffer (see
java.net.StandardSocketOptions.SO_RCVBUF)- keepAlive
whether keep-alive on tcp is used (see
java.net.StandardSocketOptions.SO_KEEPALIVE)- noDelay
whether tcp no-delay flag is set (see
java.net.StandardSocketOptions.TCP_NODELAY)
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def ensuring(cond: (SocketGroup) => Boolean, msg: => Any): SocketGroup
- Implicit
- This member is added by an implicit conversion from SocketGroup toEnsuring[SocketGroup] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (SocketGroup) => Boolean): SocketGroup
- Implicit
- This member is added by an implicit conversion from SocketGroup toEnsuring[SocketGroup] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): SocketGroup
- Implicit
- This member is added by an implicit conversion from SocketGroup toEnsuring[SocketGroup] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): SocketGroup
- Implicit
- This member is added by an implicit conversion from SocketGroup toEnsuring[SocketGroup] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from SocketGroup toStringFormat[SocketGroup] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- 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() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def server[F[_]](address: InetSocketAddress, maxQueued: Int = 0, reuseAddress: Boolean = true, receiveBufferSize: Int = 256 * 1024, additionalSocketOptions: List[SocketOptionMapping[_]] = List.empty)(implicit F: Concurrent[F], CS: ContextShift[F]): Stream[F, Resource[F, Socket[F]]]
Stream that binds to the specified address and provides a connection for, represented as a Socket, for each client that connects to the bound address.
Stream that binds to the specified address and provides a connection for, represented as a Socket, for each client that connects to the bound address.
Returns a stream of stream of sockets.
The outer stream scopes the lifetime of the server socket. When the outer stream terminates, all open connections will terminate as well. The outer stream emits an element (an inner stream) for each client connection.
Each inner stream represents an individual connection, and as such, is a stream that emits a single socket. Failures that occur in an inner stream do *NOT* cause the outer stream to fail.
- address
address to accept connections from
- maxQueued
number of queued requests before they will become rejected by server (supply <= 0 for unbounded)
- reuseAddress
whether address may be reused (see
java.net.StandardSocketOptions.SO_REUSEADDR)- receiveBufferSize
size of receive buffer (see
java.net.StandardSocketOptions.SO_RCVBUF)
- def serverResource[F[_]](address: InetSocketAddress, reuseAddress: Boolean = true, receiveBufferSize: Int = 256 * 1024, additionalSocketOptions: List[SocketOptionMapping[_]] = List.empty)(implicit F: Concurrent[F], CS: ContextShift[F]): Resource[F, (InetSocketAddress, Stream[F, Resource[F, Socket[F]]])]
Like server but provides the
InetSocketAddressof the bound server socket before providing accepted sockets.Like server but provides the
InetSocketAddressof the bound server socket before providing accepted sockets. The inner stream emits one socket for each client that connects to the server. - 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 finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
- Deprecated
(Since version ) see corresponding Javadoc for more information.
- def serverWithLocalAddress[F[_]](address: InetSocketAddress, maxQueued: Int = 0, reuseAddress: Boolean = true, receiveBufferSize: Int = 256 * 1024, additionalSocketOptions: List[SocketOptionMapping[_]] = List.empty)(implicit F: Concurrent[F], CS: ContextShift[F]): Stream[F, Either[InetSocketAddress, Resource[F, Socket[F]]]]
- Annotations
- @deprecated
- Deprecated
(Since version 2.2.0) Use serverResource instead
- def →[B](y: B): (SocketGroup, B)
- Implicit
- This member is added by an implicit conversion from SocketGroup toArrowAssoc[SocketGroup] 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.