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
- Alphabetic
- By Inheritance
- Socket
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- trait AnySourceGroupMembership extends GroupMembership
Result of joining an any-source multicast group on a UDP socket.
- trait GroupMembership extends AnyRef
Result of joining a multicast group on a UDP socket.
Abstract Value Members
- abstract def close: F[Unit]
Closes this socket.
- 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
- 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
- abstract def localAddress: F[InetSocketAddress]
Returns the local address of this udp socket.
- 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
timeoutis specified, then resultingFwill fail withjava.nio.channels.InterruptedByTimeoutExceptionif read was not satisfied in given timeout. - 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
readsmay execute at same time, causing each evaluation to receive fair amount of messages.If
timeoutis specified, then resulting stream will fail withjava.nio.channels.InterruptedByTimeoutExceptionif a read was not satisfied in given timeout.- returns
stream of packets
- 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
timeoutis specified, then resultingFwill fail withjava.nio.channels.InterruptedByTimeoutExceptionif write was not completed in given timeout.- packet
Packet to write
- 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
timeoutis specified, then resulting pipe will fail withjava.nio.channels.InterruptedByTimeoutExceptionif a write was not completed in given timeout.
Concrete 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 clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- 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()
- 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