Socket

fs2.io.net.Socket
See theSocket companion object
trait Socket[F[_]]

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

Attributes

Companion:
object
Source:
Socket.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait TLSSocket[F]

Members list

Concise view

Value members

Abstract methods

Indicates that this channel will not read more data. Causes End-Of-Stream be signalled to available. This is a no-op on Node.js.

Indicates that this channel will not read more data. Causes End-Of-Stream be signalled to available. This is a no-op on Node.js.

Attributes

Source:
Socket.scala

Indicates to peer, we are done writing. *

Indicates to peer, we are done writing. *

Attributes

Source:
Socket.scala
def isOpen: F[Boolean]

Attributes

Source:
Socket.scala

Asks for the local address of the socket.

Asks for the local address of the socket.

Attributes

Source:
Socket.scala
def read(maxBytes: Int): F[Option[Chunk[Byte]]]

Reads up to maxBytes from the peer.

Reads up to maxBytes from the peer.

Returns None if the "end of stream" is reached, indicating there will be no more bytes sent.

Attributes

Source:
Socket.scala
def readN(numBytes: Int): F[Chunk[Byte]]

Reads exactly numBytes from the peer in a single chunk.

Reads exactly numBytes from the peer in a single chunk.

Returns a chunk with size < numBytes upon reaching the end of the stream.

Attributes

Source:
Socket.scala
def reads: Stream[F, Byte]

Reads bytes from the socket as a stream.

Reads bytes from the socket as a stream.

Attributes

Source:
Socket.scala

Asks for the remote address of the peer.

Asks for the remote address of the peer.

Attributes

Source:
Socket.scala
def write(bytes: Chunk[Byte]): F[Unit]

Writes bytes to the peer.

Writes bytes to the peer.

Completes when the bytes are written to the socket.

Attributes

Source:
Socket.scala
def writes: (F, Byte) => Nothing

Writes the supplied stream of bytes to this socket via write semantics.

Writes the supplied stream of bytes to this socket via write semantics.

Attributes

Source:
Socket.scala