Socket

trait Socket[F[_]]

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

Companion
object
class Object
trait Matchable
class Any
trait TLSSocket[F]

Value members

Abstract methods

def endOfInput: F[Unit]

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.

def endOfOutput: F[Unit]

Indicates to peer, we are done writing. *

Indicates to peer, we are done writing. *

def isOpen: F[Boolean]
def localAddress: F[SocketAddress[IpAddress]]

Asks for the local address of the socket.

Asks for the local address of the socket.

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.

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.

def reads: Stream[F, Byte]

Reads bytes from the socket as a stream.

Reads bytes from the socket as a stream.

def remoteAddress: F[SocketAddress[IpAddress]]

Asks for the remote address of the peer.

Asks for the remote address of the peer.

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.

def writes: (F, Byte) => INothing

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

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