Packages

sealed trait Socket[F[_]] extends AnyRef

Provides the ability to read/write from a UDP socket in the effect F.

To construct a Socket, use the methods in the fs2.io.udp package object.

Source
Socket.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Socket
  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

Type Members

  1. sealed trait AnySourceGroupMembership extends GroupMembership

    Result of joining an any-source multicast group on a UDP socket.

  2. sealed trait GroupMembership extends AnyRef

    Result of joining a multicast group on a UDP socket.

Abstract Value Members

  1. abstract def close: F[Unit]

    Closes this socket.

  2. abstract def join(group: InetAddress, interface: NetworkInterface, source: InetAddress): F[GroupMembership]

    Joins a source specific multicast group on a specific network interface.

    Joins a source specific multicast group on a specific network interface.

    group

    address of group to join

    interface

    network interface upon which to listen for datagrams

    source

    limits received packets to those sent by the source

  3. abstract def join(group: InetAddress, interface: NetworkInterface): F[AnySourceGroupMembership]

    Joins a multicast group on a specific network interface.

    Joins a multicast group on a specific network interface.

    group

    address of group to join

    interface

    network interface upon which to listen for datagrams

  4. abstract def localAddress: F[InetSocketAddress]

    Returns the local address of this udp socket.

  5. abstract def read(timeout: Option[FiniteDuration] = None): F[Packet]

    Reads a single packet from this udp socket.

    Reads a single packet from this udp socket.

    If timeout is specified, then resulting F will fail with java.nio.channels.InterruptedByTimeoutException if read was not satisfied in given timeout.

  6. abstract def reads(timeout: Option[FiniteDuration] = None): Stream[F, Packet]

    Reads packets received from this udp socket.

    Reads packets received from this udp socket.

    Note that multiple reads may execute at same time, causing each evaluation to receive fair amount of messages.

    If timeout is specified, then resulting stream will fail with java.nio.channels.InterruptedByTimeoutException if a read was not satisfied in given timeout.

    returns

    stream of packets

  7. abstract def write(packet: Packet, timeout: Option[FiniteDuration] = None): F[Unit]

    Write a single packet to this udp socket.

    Write a single packet to this udp socket.

    If timeout is specified, then resulting F will fail with java.nio.channels.InterruptedByTimeoutException if write was not completed in given timeout.

    packet

    Packet to write

  8. abstract def writes(timeout: Option[FiniteDuration] = None): Pipe[F, Packet, Unit]

    Writes supplied packets to this udp socket.

    Writes supplied packets to this udp socket.

    If timeout is specified, then resulting pipe will fail with java.nio.channels.InterruptedByTimeoutException if a write was not completed in given timeout.

Concrete 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 Socket[F] to any2stringadd[Socket[F]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Socket[F], B)
    Implicit
    This member is added by an implicit conversion from Socket[F] to ArrowAssoc[Socket[F]] 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 clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  8. def ensuring(cond: (Socket[F]) ⇒ Boolean, msg: ⇒ Any): Socket[F]
    Implicit
    This member is added by an implicit conversion from Socket[F] to Ensuring[Socket[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (Socket[F]) ⇒ Boolean): Socket[F]
    Implicit
    This member is added by an implicit conversion from Socket[F] to Ensuring[Socket[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): Socket[F]
    Implicit
    This member is added by an implicit conversion from Socket[F] to Ensuring[Socket[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): Socket[F]
    Implicit
    This member is added by an implicit conversion from Socket[F] to Ensuring[Socket[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Socket[F] to StringFormat[Socket[F]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  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()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  27. def →[B](y: B): (Socket[F], B)
    Implicit
    This member is added by an implicit conversion from Socket[F] to ArrowAssoc[Socket[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Socket[F] to any2stringadd[Socket[F]]

Inherited by implicit conversion StringFormat from Socket[F] to StringFormat[Socket[F]]

Inherited by implicit conversion Ensuring from Socket[F] to Ensuring[Socket[F]]

Inherited by implicit conversion ArrowAssoc from Socket[F] to ArrowAssoc[Socket[F]]

Ungrouped