Spikard.WebSocketMessage (spikard v0.15.6-rc.9)

A WebSocket message that can be text or binary.

Summary

binary_variant()

A binary message.

close()

A close message with a numeric close code (RFC 6455) and optional reason text.

ping()

A ping message.

pong()

A pong message.

t()

A WebSocket message that can be text or binary.

text()

A text message.

@type binary_variant() :: %{type: :binary, value: binary()}

A binary message.

@type close() :: %{type: :close, code: non_neg_integer(), reason: String.t()}

A close message with a numeric close code (RFC 6455) and optional reason text.

@type ping() :: %{type: :ping, value: binary()}

A ping message.

@type pong() :: %{type: :pong, value: binary()}

A pong message.

@type t() :: term()

A WebSocket message that can be text or binary.

@type text() :: %{type: :text, value: String.t()}

A text message.