package websocket
- Source
- package.scala
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- websocket
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- All
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
Value Members
- def websocketKey[F[_]]: Key[WebSocketContext[F]]
- object WebSocketBuilder extends Serializable