Package

spinoco.fs2.http

websocket

Permalink

package websocket

Source
package.scala
Linear Supertypes
AnyRef, Any
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. sealed trait Frame[A] extends AnyRef

    Permalink
  2. case class WebSocketRequest(hostPort: HostPort, header: HttpRequestHeader, secure: Boolean) extends Product with Serializable

    Permalink

    Request to establish websocket connection from the client

    Request to establish websocket connection from the client

    hostPort

    Host (port) of the server

    header

    Any Header information. Note that Method will be always GET replacing any other method configured. Also any WebSocket Handshake headers will be overriden.

    secure

    True, if the connection shall be secure (wss)

Value Members

  1. object Frame

    Permalink
  2. object WebSocket

    Permalink
  3. object WebSocketRequest extends Serializable

    Permalink
  4. def server[F[_], I, O](pipe: Pipe[F, Frame[I], Frame[O]], pingInterval: Duration = 30.seconds, handshakeTimeout: FiniteDuration = 10.seconds)(header: HttpRequestHeader, input: Stream[F, Byte])(implicit R: Decoder[I], W: Encoder[O], F: Async[F], S: Scheduler): Stream[F, HttpResponse[F]]

    Permalink

    Creates a websocket to be used on server side.

    Creates a websocket to be used on server side.

    Implementation is according to RFC-6455 (https://tools.ietf.org/html/rfc6455).

    pipe

    A websocket pipe. I is received from the client and O is sent to client. Decoder (for I) and Encoder (for O) must be supplied. Note that this function may evaluate on the left, to indicate response to the client before the handshake took place (i.e. Unauthorized).

    pingInterval

    An interval for the Ping / Pong protocol.

    handshakeTimeout

    An timeout to await for handshake to be successfull. If the handshake is not completed within supplied period, connection is terminated.

Inherited from AnyRef

Inherited from Any

Ungrouped