sttp.ws

package sttp.ws

Type members

Classlikes

trait WebSocket[F[_]]

Effectful interactions with a web socket. Interactions can happen:

Effectful interactions with a web socket. Interactions can happen:

  • on the frame level, by sending and receiving raw WebSocketFrame s
  • using the provided receive* methods to obtain concatenated data frames, or string/byte payloads, and the send* method to send string/binary frames.

The send* and receive* methods may result in a failed effect, with either one of WebSocketException exceptions, or a backend-specific exception. Specifically, they will fail with WebSocketClosed if the web socket is closed.

See the either and eitherClose method to lift web socket closed events to the value level.

case class WebSocketBufferFull(capacity: Int) extends WebSocketException
case class WebSocketClosed(frame: Option[Close]) extends WebSocketException
Value parameters:
frame

The received closing frame, if available.

abstract class WebSocketException(msg: String) extends Exception
sealed trait WebSocketFrame
Companion:
object
Companion:
class