Represents a WebSocket binary message. A binary message can either be strict in which case the complete data is already available or it can be streamed in which case getStreamedData will return a Source streaming the data as it comes in.

Represents a WebSocket message. A message can either be a binary message or a text message.

A PeerClosedConnectionException will be reported to the WebSocket handler if the peer has closed the connection. closeCode and closeReason contain close messages as reported by the peer.

Represents a WebSocket text message. A text message can either be strict in which case the complete data is already available or it can be streamed in which case getStreamedText will return a Source streaming the data as it comes in.

Represents a WebSocket request. Use WebSocketRequest.create to create a request for a target URI and then use addHeader or requestSubprotocol to set optional details.

An attribute that WebSocket requests will contain. Use WebSocketUpgrade.handleMessagesWith to create a WebSocket handshake response and handle the WebSocket message stream with the given handler.

This is a low-level API. You might want to use handleWebSocketMessages instead as documented at https://pekko.apache.org/docs/pekko-http/current/server-side/websocket-support.html#routing-support

Represents an upgrade response for a WebSocket upgrade request. Can either be valid, in which case the chosenSubprotocol method is valid, or if invalid, the invalidationReason method can be used to find out why the upgrade failed.

A virtual header that WebSocket requests will contain. Use UpgradeToWebSocket.handleMessagesWith to create a WebSocket handshake response and handle the WebSocket message stream with the given handler.

This low-level API is expected to be replaced by an Attribute in the future.

In any case, you might want to use handleWebSocketMessages instead as documented at https://pekko.apache.org/docs/pekko-http/current/server-side/websocket-support.html#routing-support