package websocket
- Source
- package.scala
- Alphabetic
- By Inheritance
- websocket
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- sealed abstract class WebSocketBuilder2[F[_]] extends AnyRef
Build a response which will accept an HTTP websocket upgrade request and initiate a websocket connection using the supplied exchange to process and respond to websocket messages.
Deprecated Type Members
- final case class WebSocketBuilder[F[_]](headers: Headers, onNonWebSocketRequest: F[Response[F]], onHandshakeFailure: F[Response[F]], onClose: F[Unit], filterPingPongs: Boolean)(implicit evidence$1: Applicative[F]) extends Product with Serializable
Build a response which will accept an HTTP websocket upgrade request and initiate a websocket connection using the supplied exchange to process and respond to websocket messages.
Build a response which will accept an HTTP websocket upgrade request and initiate a websocket connection using the supplied exchange to process and respond to websocket messages.
- headers
Handshake response headers, such as such as:Sec-WebSocket-Protocol.
- onNonWebSocketRequest
The status code to return to a client making a non-websocket HTTP request to this route. default: NotImplemented
- onHandshakeFailure
The status code to return when failing to handle a websocket HTTP request to this route. default: BadRequest
- Annotations
- @deprecated
- Deprecated
(Since version 0.23.5) Relies on an unsafe cast; instead obtain a WebSocketBuilder2 via .withHttpWebSocketApp on your server builder
Value Members
- object WebSocketBuilder2
Deprecated Value Members
- def websocketKey[F[_]]: Key[WebSocketContext[F]]
- Annotations
- @deprecated
- Deprecated
(Since version 0.23.5) Performs an unsafe cast. Should be passed in from the backend builder that knows what F is.
- object WebSocketBuilder extends Serializable
- Annotations
- @deprecated
- Deprecated
(Since version 0.23.5) Relies on an unsafe cast; instead obtain a WebSocketBuilder2 via .withHttpWebSocketApp on your server builder