Type Members

1.  abstract class BinaryMessage extends Message

   Represents a WebSocket binary message.

   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.

2.  abstract class Message extends AnyRef

   Represents a WebSocket message.

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

   Annotations

   @DoNotInherit()

3.  trait PeerClosedConnectionException extends RuntimeException

   A PeerClosedConnectionException will be reported to the WebSocket handler if the peer has closed the connection.

   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.

4.  abstract class TextMessage extends Message

   Represents a WebSocket text message.

   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.

5.  abstract class WebSocketRequest extends AnyRef

   Represents a WebSocket request.

   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.

6.  trait WebSocketUpgrade extends AnyRef

   An attribute that WebSocket requests will contain.

   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

7.  trait WebSocketUpgradeResponse extends AnyRef

   Represents an upgrade response for a WebSocket upgrade request.

   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.