Packages

p

org.http4s.server

websocket

package websocket

Source
package.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. websocket
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. 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]) extends Product with Serializable

    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.

    headers

    Handshake response headers, such as such as:Sec-WebSocket-Protocol.

    onNonWebSocketRequest

    The status code to return to a client making a non-websocket HTTP request to this route. default: NotImplemented

    onHandshakeFailure

    The status code to return when failing to handle a websocket HTTP request to this route. default: BadRequest

Value Members

  1. def websocketKey[F[_]]: Key[WebSocketContext[F]]
  2. object WebSocketBuilder extends Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped