http4s-jdk-http-client/org.http4s.jdkhttpclient/WSConnectionHighLevel

WSConnectionHighLevel

trait WSConnectionHighLevel[F[_]]
class Object
trait Matchable
class Any

Value members

Abstract methods

def closeFrame: TryableDeferred[F, Close]

The close frame, if available.

The close frame, if available.

def receive: F[Option[WSDataFrame]]

Wait for a websocket frame to be received. Returns None if the receiving side is closed. Fragmentation is handled automatically, the last attribute can be ignored.

Wait for a websocket frame to be received. Returns None if the receiving side is closed. Fragmentation is handled automatically, the last attribute can be ignored.

def send(wsf: WSDataFrame): F[Unit]

Send a single websocket frame. The sending side of this connection has to be open.

Send a single websocket frame. The sending side of this connection has to be open.

def sendClose(reason: String): F[Unit]

Send a Close frame. The sending side of this connection will be closed.

Send a Close frame. The sending side of this connection will be closed.

def sendMany[G[_], A <: WSDataFrame](wsfs: G[A])(`evidence$2`: Foldable[G]): F[Unit]

Send multiple websocket frames. Equivalent to multiple send calls, but at least as fast.

Send multiple websocket frames. Equivalent to multiple send calls, but at least as fast.

def sendPing(data: ByteVector): F[Unit]

Send a Ping frame.

Send a Ping frame.

def subprocotol: Option[String]

The negotiated subprotocol, if any.

The negotiated subprotocol, if any.

Concrete methods

final def receiveStream: Stream[F, WSDataFrame]

A stream of the incoming websocket frames.

A stream of the incoming websocket frames.

final def sendPipe: (F, WSDataFrame) => Unit

A Pipe which sends websocket frames and emits a () for each chunk sent.

A Pipe which sends websocket frames and emits a () for each chunk sent.