org.http4s.server.websocket

Type members

Classlikes

sealed abstract class WebSocketBuilder[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
Source:
WebSocketBuilder.scala

Deprecated types

@deprecated("Renamed to WebSocketBuilder", "1.0.0-M28")
Deprecated
Source:
package.scala

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")
Deprecated
Source:
package.scala

Deprecated fields

@deprecated("Renamed to WebSocketBuilder", "1.0.0-M28")
Deprecated
Source:
package.scala