org.http4s.server.websocket
package org.http4s.server.websocket
Type members
Classlikes
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])
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.
- Value Params
- headers
Handshake response headers, such as such as:Sec-WebSocket-Protocol.
- onHandshakeFailure
The status code to return when failing to handle a websocket HTTP request to this route. default: BadRequest
- onNonWebSocketRequest
The status code to return to a client making a non-websocket HTTP request to this route. default: NotImplemented
- Companion
- object