sttp.ws
package sttp.ws
Type members
Classlikes
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 thesend*
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.
- Value parameters:
- frame
The received closing frame, if available.