fs2-io/fs2.io.tls/TLSSocket

TLSSocket

sealed trait TLSSocket[F <: ([_$1] =>> Any)] extends Socket[F]
TCP socket that supports encryption via TLS.
To construct a TLSSocket, use the client and server methods on TLSContext.
Companion
object
trait Socket[F]
class Object
trait Matchable
class Any

Value members

Methods

def beginHandshake: F[Unit]
Initiates handshaking -- either the initial or a renegotiation.
def session: F[SSLSession]
Provides access to the current SSLSession for purposes of querying
session info such as the negotiated cipher suite or the peer certificate.
def applicationProtocol: F[String]
Provides access to the current application protocol that has been negotiated.

Inherited methods

def endOfOutput: F[Unit]
Indicates to peer, we are done writing. *
Inhertied from
Socket
def remoteAddress: F[SocketAddress]
Asks for the remote address of the peer.
Inhertied from
Socket
def reads(maxBytes: Int, timeout: Option[FiniteDuration]): Stream[F, Byte]
Reads stream of bytes from this socket with read semantics. Terminates when eof is received.
On timeout, this fails with java.nio.channels.InterruptedByTimeoutException.
Inhertied from
Socket
def localAddress: F[SocketAddress]
Asks for the local address of the socket.
Inhertied from
Socket
def write(bytes: Chunk[Byte], timeout: Option[FiniteDuration]): F[Unit]
Writes bytes to the peer. If timeout is provided
and the operation does not complete in the specified duration,
the returned Process fails with a java.nio.channels.InterruptedByTimeoutException.
Completes when bytes are written to the socket.
Inhertied from
Socket
def readN(numBytes: Int, timeout: Option[FiniteDuration]): F[Option[Chunk[Byte]]]
Reads exactly numBytes from the peer in a single chunk.
If timeout is provided and no data arrives within the specified duration, then this results in
failure with java.nio.channels.InterruptedByTimeoutException.
When returned size of bytes is < numBytes that indicates end-of-stream has been reached.
Inhertied from
Socket
def close: F[Unit]
Closes the connection corresponding to this Socket.
Inhertied from
Socket
def endOfInput: F[Unit]
Indicates that this channel will not read more data. Causes End-Of-Stream be signalled to available.
Inhertied from
Socket
def read(maxBytes: Int, timeout: Option[FiniteDuration]): F[Option[Chunk[Byte]]]
Reads up to maxBytes from the peer.
Evaluates to None, if there are no more bytes to be read in future, due stream reached End-Of-Stream state
before returning even single byte. Otherwise returns Some(bytes) with bytes that were ready to be read.
If timeout is specified, then resulting F will evaluate to failure with java.nio.channels.InterruptedByTimeoutException
if read was not satisfied in given timeout. Read is satisfied, when at least single Byte was received
before timeout expires.
This may return None, as well when end of stream has been reached before timeout expired and no data
has been received.
Inhertied from
Socket
def isOpen: F[Boolean]
Inhertied from
Socket
def writes(timeout: Option[FiniteDuration]): (F, Byte) => INothing
Writes the supplied stream of bytes to this socket via write semantics.
Inhertied from
Socket