core
API
Generated with
core/sttp.client4/sttp.client4.ws/SyncWebSocket

SyncWebSocket

sttp.client4.ws.SyncWebSocket
class SyncWebSocket(val delegate: WebSocket[Identity])

Allows interacting 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 sttp.ws.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

Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def close(): Unit

Idempotent when used sequentially.

Idempotent when used sequentially.

Attributes

def either[T](f: => T): Either[Option[Close], T]

Returns an effect computing a:

Returns an effect computing a:

  • Left if the web socket is closed - optionally with the received close frame (if available).
  • Right with the original result otherwise.

Will never throw a WebSocketClosed.

Value parameters

f

The effect describing web socket interactions.

Attributes

def eitherClose[T](f: => T): Either[Close, T]

Extracts the received close frame (if available) as the left side of an either, or returns the original result on the right.

Extracts the received close frame (if available) as the left side of an either, or returns the original result on the right.

Will throw WebSocketClosed if the web socket is closed, but no close frame is available.

Value parameters

f

The effect describing web socket interactions.

Attributes

def isOpen(): Boolean
def receive(): WebSocketFrame

Receive the next frame from the web socket. This can be a data frame, or a control frame including WebSocketFrame.Close. After receiving a close frame, no further interactions with the web socket should happen.

Receive the next frame from the web socket. This can be a data frame, or a control frame including WebSocketFrame.Close. After receiving a close frame, no further interactions with the web socket should happen.

However, not all implementations expose the close frame, and web sockets might also get closed without the proper close frame exchange. In such cases, as well as when invoking receive/send after receiving a close frame, a WebSocketClosed exception will be thrown.

Should be only called sequentially! (from a single thread/fiber). Because web socket frames might be fragmented, calling this method concurrently might result in threads/fibers receiving fragments of the same frame.

Attributes

def receiveBinary(pongOnPing: Boolean): Array[Byte]

Receive a single binary message (which might come from multiple, fragmented frames). Ignores non-binary frames and returns combined results. Will throw WebSocketClosed if the web socket is closed, or if a close frame is received.

Receive a single binary message (which might come from multiple, fragmented frames). Ignores non-binary frames and returns combined results. Will throw WebSocketClosed if the web socket is closed, or if a close frame is received.

Should be only called sequentially! (from a single thread/fiber).

Value parameters

pongOnPing

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

Attributes

def receiveBinaryFrame(pongOnPing: Boolean): Binary

Receive a single binary data frame, ignoring others. The frame might be a fragment. To receive whole messages, use receiveBinary. Will throw WebSocketClosed if the web socket is closed, or if a close frame is received.

Receive a single binary data frame, ignoring others. The frame might be a fragment. To receive whole messages, use receiveBinary. Will throw WebSocketClosed if the web socket is closed, or if a close frame is received.

Should be only called sequentially! (from a single thread/fiber).

Value parameters

pongOnPing

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

Attributes

def receiveDataFrame(pongOnPing: Boolean): Data[_]

Receive a single data frame, ignoring others. The frame might be a fragment. Will throw WebSocketClosed if the web socket is closed, or if a close frame is received.

Receive a single data frame, ignoring others. The frame might be a fragment. Will throw WebSocketClosed if the web socket is closed, or if a close frame is received.

Should be only called sequentially! (from a single thread/fiber).

Value parameters

pongOnPing

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

Attributes

def receiveText(pongOnPing: Boolean): String

Receive a single text message (which might come from multiple, fragmented frames). Ignores non-text frames and returns combined results. Will throw WebSocketClosed if the web socket is closed, or if a close frame is received.

Receive a single text message (which might come from multiple, fragmented frames). Ignores non-text frames and returns combined results. Will throw WebSocketClosed if the web socket is closed, or if a close frame is received.

Should be only called sequentially! (from a single thread/fiber).

Value parameters

pongOnPing

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

Attributes

def receiveTextFrame(pongOnPing: Boolean): Text

Receive a single text data frame, ignoring others. The frame might be a fragment. To receive whole messages, use receiveText. Will throw WebSocketClosed if the web socket is closed, or if a close frame is received.

Receive a single text data frame, ignoring others. The frame might be a fragment. To receive whole messages, use receiveText. Will throw WebSocketClosed if the web socket is closed, or if a close frame is received.

Should be only called sequentially! (from a single thread/fiber).

Value parameters

pongOnPing

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

Attributes

def send(f: WebSocketFrame, isContinuation: Boolean): Unit

Sends a web socket frame. Can be safely called from multiple threads.

Sends a web socket frame. Can be safely called from multiple threads.

May result in an exception, in case of a network error, or if the socket is closed.

Attributes

def sendBinary(payload: Array[Byte]): Unit

Sends a web socket frame with the given payload. Can be safely called from multiple threads.

Sends a web socket frame with the given payload. Can be safely called from multiple threads.

May result in an exception, in case of a network error, or if the socket is closed.

Attributes

def sendText(payload: String): Unit

Sends a web socket frame with the given payload. Can be safely called from multiple threads.

Sends a web socket frame with the given payload. Can be safely called from multiple threads.

May result in an exception, in case of a network error, or if the socket is closed.

Attributes

def upgradeHeaders: Headers

Concrete fields

val delegate: WebSocket[Identity]
Generated with