org.http4s.server.websocket
Members list
Type members
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.
Value parameters
- defragFrame
-
Indicates whether incoming WebSocket frames are defragmented or not. If this flag is true, frames fragmented according to rfc6455 will arrive defragged in the user-provided recieve handler. Note that this defrag feature is true by default. To prevent WebSocketBuilder2 from handling defrag, you must explicitly call withDefragment(false). For more information on defrag processing, see the WebSocketFrameDefragmenter comment. default: true
- 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
Attributes
- Companion
- object
- Source
- WebSocketBuilder2.scala
- Supertypes
Attributes
- Companion
- class
- Source
- WebSocketBuilder2.scala
- Supertypes
- Self type
-
WebSocketBuilder2.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.
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
Attributes
- Companion
- object
- Deprecated
- true
- Source
- WebSocketBuilder.scala
- Supertypes
Attributes
- Companion
- class
- Deprecated
- true
- Source
- WebSocketBuilder.scala
- Supertypes
- Self type
-
WebSocketBuilder.type
Value members
Deprecated methods
Attributes
- Deprecated
- true
- Source
- package.scala