Packages

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
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SocketGroup
  2. AnyRef
  3. 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 SocketGroup(channelGroup: AsynchronousChannelGroup, blocker: Blocker)

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 SocketGroup to any2stringadd[SocketGroup] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (SocketGroup, B)
    Implicit
    This member is added by an implicit conversion from SocketGroup to ArrowAssoc[SocketGroup] 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 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)

  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  9. def ensuring(cond: (SocketGroup) ⇒ Boolean, msg: ⇒ Any): SocketGroup
    Implicit
    This member is added by an implicit conversion from SocketGroup to Ensuring[SocketGroup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (SocketGroup) ⇒ Boolean): SocketGroup
    Implicit
    This member is added by an implicit conversion from SocketGroup to Ensuring[SocketGroup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: ⇒ Any): SocketGroup
    Implicit
    This member is added by an implicit conversion from SocketGroup to Ensuring[SocketGroup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): SocketGroup
    Implicit
    This member is added by an implicit conversion from SocketGroup to Ensuring[SocketGroup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from SocketGroup to StringFormat[SocketGroup] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. 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)

  23. 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 InetSocketAddress of the bound server socket before providing accepted sockets.

    Like server but provides the InetSocketAddress of the bound server socket before providing accepted sockets. The inner stream emits one socket for each client that connects to the server.

  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. def →[B](y: B): (SocketGroup, B)
    Implicit
    This member is added by an implicit conversion from SocketGroup to ArrowAssoc[SocketGroup] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

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

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

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from SocketGroup to any2stringadd[SocketGroup]

Inherited by implicit conversion StringFormat from SocketGroup to StringFormat[SocketGroup]

Inherited by implicit conversion Ensuring from SocketGroup to Ensuring[SocketGroup]

Inherited by implicit conversion ArrowAssoc from SocketGroup to ArrowAssoc[SocketGroup]

Ungrouped