ws
API
Generated with
ws/sttp.ws

sttp.ws

package sttp.ws

Members list

Packages

package sttp.ws.testing

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.

Attributes

Supertypes
class Object
trait Matchable
class Any
case class WebSocketBufferFull(capacity: Int) extends WebSocketException

Attributes

Supertypes
trait Product
trait Equals
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
case class WebSocketClosed(frame: Option[Close]) extends WebSocketException

Value parameters

frame

The received closing frame, if available.

Attributes

Supertypes
trait Product
trait Equals
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
abstract class WebSocketException(msg: String) extends Exception

Attributes

Supertypes
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
sealed trait WebSocketFrame

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Control
class Close
class Ping
class Pong
trait Data[T]
class Binary
class Text
Show all
object WebSocketFrame

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Generated with