Trait/Object

fs2.io.udp

Socket

Related Docs: object Socket | package udp

Permalink

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

    Permalink

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

  2. sealed trait GroupMembership extends AnyRef

    Permalink

    Result of joining a multicast group on a UDP socket.

Abstract Value Members

  1. abstract def close: F[Unit]

    Permalink

    Closes this socket.

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

    Permalink

    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]

    Permalink

    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]

    Permalink

    Returns the local address of this udp socket.

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

    Permalink

    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]

    Permalink

    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]

    Permalink

    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): Sink[F, Packet]

    Permalink

    Writes supplied packets to this udp socket.

    Writes supplied packets to this udp socket.

    If timeout is specified, then resulting sink 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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    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)

    Permalink
    Implicit information
    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

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  8. def ensuring(cond: (Socket[F]) ⇒ Boolean, msg: ⇒ Any): Socket[F]

    Permalink
    Implicit information
    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]

    Permalink
    Implicit information
    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]

    Permalink
    Implicit information
    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]

    Permalink
    Implicit information
    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

    Permalink
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  14. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    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()
  15. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  19. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  21. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  22. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  23. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. def [B](y: B): (Socket[F], B)

    Permalink
    Implicit information
    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

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

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