ZenWebsocket.Frame (ZenWebsocket v0.4.2)

WebSocket frame encoding and decoding utilities.

API Functions

Function	Arity	Description	Param Kinds
`decode`	1	Decode an incoming WebSocket frame from Gun or direct format.	`frame: value`
`pong`	1	Create a WebSocket pong frame with optional payload.	`payload: value`
`ping`	0	Create a WebSocket ping frame.	-
`binary`	1	Encode binary data as a WebSocket frame.	`data: value`
`text`	1	Encode a text message as a WebSocket frame.	`message: value`

frame()

frame_type()

binary(data)

Encode binary message as WebSocket frame.

decode(frame)

Decode incoming WebSocket frame. Handles both Gun WebSocket format {:ws, type, data} and direct frame format {:type, data}.

ping()

Create ping frame.

Create pong frame with payload.

text(message)

Encode text message as WebSocket frame.

@type frame() :: {frame_type(), binary()}

@type frame_type() :: :text | :binary | :ping | :pong | :close

@spec binary(binary()) :: frame()

Encode binary message as WebSocket frame.

@spec decode(tuple()) :: {:ok, frame()} | {:error, String.t()}

Decode incoming WebSocket frame. Handles both Gun WebSocket format {:ws, type, data} and direct frame format {:type, data}.

@spec ping() :: frame()

Create ping frame.

@spec pong(binary()) :: frame()

Create pong frame with payload.

@spec text(String.t()) :: frame()

Encode text message as WebSocket frame.