WebSocket
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 WebSocketFrames
- 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 members
Abstract methods
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,
this effect will fail with the WebSocketClosed exception.
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.
Concrete methods
Returns an effect computing a:
Returns an effect computing a:
Leftif the web socket is closed - optionally with the received close frame (if available).Rightwith the original result otherwise.
Will never fail with a WebSocketClosed.
- Value Params
- f
The effect describing web socket interactions.
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 fail with WebSocketClosed if the web socket is closed, but no close frame is available.
- Value Params
- f
The effect describing web socket interactions.
Receive a single binary message (which might come from multiple, fragmented frames). Ignores non-binary frames and returns combined results. Will fail with 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 fail with 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 Params
- pongOnPing
Should a WebSocketFrame.Pong be sent when a WebSocketFrame.Ping is received.
Receive a single binary data frame, ignoring others. The frame might be a fragment. To receive whole messages, use receiveBinary. Will fail with 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 fail with 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 Params
- pongOnPing
Should a WebSocketFrame.Pong be sent when a WebSocketFrame.Ping is received.
Receive a single data frame, ignoring others. The frame might be a fragment. Will fail with 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 fail with 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 Params
- pongOnPing
Should a WebSocketFrame.Pong be sent when a WebSocketFrame.Ping is received.
Receive a single text message (which might come from multiple, fragmented frames). Ignores non-text frames and returns combined results. Will fail with 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 fail with 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 Params
- pongOnPing
Should a WebSocketFrame.Pong be sent when a WebSocketFrame.Ping is received.
Receive a single text data frame, ignoring others. The frame might be a fragment. To receive whole messages, use receiveText. Will fail with 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 fail with 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 Params
- pongOnPing
Should a WebSocketFrame.Pong be sent when a WebSocketFrame.Ping is received.
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 a failed effect, in case of a network error, or if the socket is closed.