org.http4s.server.websocket

Members list

Concise view

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.

Attributes

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:
WebSocketBuilder2.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Attributes

Companion:
class
Source:
WebSocketBuilder2.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Deprecated classlikes

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.

Attributes

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
true
Source:
WebSocketBuilder.scala
Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any

Attributes

Companion:
class
Deprecated
true
Source:
WebSocketBuilder.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Value members

Deprecated methods

Attributes

Deprecated
true
Source:
package.scala