unidocs/org.http4s.server.websocket

org.http4s.server.websocket

package org.http4s.server.websocket

Type members

Classlikes

sealed abstract class WebSocketBuilder2[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 parameters:
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
object WebSocketBuilder2
Companion:
class

Deprecated classlikes

@deprecated("Relies on an unsafe cast; instead obtain a WebSocketBuilder2 via .withHttpWebSocketApp on your server builder", "0.23.5")
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 parameters:
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
Deprecated
@deprecated("Relies on an unsafe cast; instead obtain a WebSocketBuilder2 via .withHttpWebSocketApp on your server builder", "0.23.5")
object WebSocketBuilder
Companion:
class
Deprecated

Value members

Deprecated methods

@deprecated("Performs an unsafe cast. Should be passed in from the backend builder that knows what F is.", "0.23.5")
def websocketKey[F[_]]: Key[WebSocketContext[F]]
Deprecated