Packages

t

sttp.client.ws

WebSocket

trait WebSocket[F[_]] extends AnyRef

The send and receive methods may result in a failed effect, with either one of sttp.model.ws.WebSocketException exceptions, or a backend-specific exception.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WebSocket
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def isOpen: F[Boolean]
  2. implicit abstract def monad: MonadError[F]
  3. abstract def receive: F[Either[Close, Incoming]]
  4. abstract def send(f: WebSocketFrame, isContinuation: Boolean = false): F[Unit]

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. def close: F[Unit]
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. def receiveBinary(pongOnPing: Boolean): F[Either[Close, Array[Byte]]]

    Receive a single binary message (which might come from multiple, fragmented frames).

    Receive a single binary message (which might come from multiple, fragmented frames). Ignores non-binary frames and returns combined results.

    pongOnPing

    Should a WebSocketFrame.Pong be sent when a WebSocketFrame.Ping is received.

  16. def receiveBinaryFrame(pongOnPing: Boolean = true): F[Either[Close, Binary]]

    Receive a single binary data frame, ignoring others.

    Receive a single binary data frame, ignoring others. The frame might be a fragment. To receive whole messages, use receiveBinary.

    pongOnPing

    Should a WebSocketFrame.Pong be sent when a WebSocketFrame.Ping is received.

  17. def receiveDataFrame(pongOnPing: Boolean = true): F[Either[Close, Data[_]]]

    Receive a single data frame, ignoring others.

    Receive a single data frame, ignoring others. The frame might be a fragment.

    pongOnPing

    Should a WebSocketFrame.Pong be sent when a WebSocketFrame.Ping is received.

  18. def receiveText(pongOnPing: Boolean = true): F[Either[Close, String]]

    Receive a single text message (which might come from multiple, fragmented frames).

    Receive a single text message (which might come from multiple, fragmented frames). Ignores non-text frames and returns combined results.

    pongOnPing

    Should a WebSocketFrame.Pong be sent when a WebSocketFrame.Ping is received.

  19. def receiveTextFrame(pongOnPing: Boolean = true): F[Either[Close, Text]]

    Receive a single text data frame, ignoring others.

    Receive a single text data frame, ignoring others. The frame might be a fragment. To receive whole messages, use receiveText.

    pongOnPing

    Should a WebSocketFrame.Pong be sent when a WebSocketFrame.Ping is received.

  20. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped