package ws
Ordering
- Alphabetic
Visibility
- Public
- All
Type Members
-
trait
WebSocket[F[_]] extends AnyRef
Effectful interactions with a web socket.
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*
andreceive*
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
andeitherClose
method to lift web socket closed events to the value level. - case class WebSocketBufferFull(capacity: Int) extends WebSocketException with Product with Serializable
-
case class
WebSocketClosed(frame: Option[Close]) extends WebSocketException with Product with Serializable
- frame
The received closing frame, if available.
- abstract class WebSocketException extends Exception
- sealed trait WebSocketFrame extends AnyRef
Value Members
- object WebSocketFrame