client/org.http4s.client.websocket/WSConnection

WSConnection

trait WSConnection[F[_]]
Source:
WSClient.scala
class Object
trait Matchable
class Any

Value members

Abstract methods

def receive: F[Option[WSFrame]]

Wait for a single websocket frame to be received. Returns None if the receiving side is closed.

Wait for a single websocket frame to be received. Returns None if the receiving side is closed.

Source:
WSClient.scala
def send(wsf: WSFrame): 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.

Source:
WSClient.scala
def sendMany[G[_] : Foldable, A <: WSFrame](wsfs: G[A]): 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.

Source:
WSClient.scala
def subprotocol: Option[String]

The negotiated subprotocol, if any.

The negotiated subprotocol, if any.

Source:
WSClient.scala

Concrete methods

def mapK[G[_]](fk: FunctionK[F, G]): WSConnection[G]
def receiveStream: Stream[F, WSFrame]

A stream of the incoming websocket frames.

A stream of the incoming websocket frames.

Source:
WSClient.scala
def sendPipe: (F, WSFrame) => 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.

Source:
WSClient.scala