SecWebSocketKey

zio.http.Header.SecWebSocketKey
See theSecWebSocketKey companion class
object SecWebSocketKey extends HeaderType

The Sec-WebSocket-Key header is used in the WebSocket handshake. It is sent from the client to the server to provide part of the information used by the server to prove that it received a valid WebSocket handshake. This helps ensure that the server does not accept connections from non-WebSocket clients (e.g. HTTP clients) that are being abused to send data to unsuspecting WebSocket servers.

See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Sec-WebSocket-Key

Attributes

Companion
class
Source
Header.scala
Graph
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type

Members list

Type members

Types

override type HeaderValue = SecWebSocketKey

Attributes

Source
Header.scala

Inherited and Abstract types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
Source
Mirror.scala
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror
Source
Mirror.scala

Value members

Concrete methods

override def name: String

Attributes

Definition Classes
Source
Header.scala
def parse(key: String): Either[String, SecWebSocketKey]

Attributes

Source
Header.scala
def render(secWebSocketKey: SecWebSocketKey): String

Attributes

Source
Header.scala

Inherited methods

def fromHeaders(headers: Headers): Either[String, HeaderValue]

Attributes

Inherited from:
HeaderType
Source
Header.scala
def names: Chunk[String]

Attributes

Inherited from:
HeaderType
Source
Header.scala
override def toHeaders(value: HeaderValue): Headers

Attributes

Definition Classes
Inherited from:
HeaderType
Source
Header.scala