API Reference ws v#0.3.0

View Source

Modules

ws

Public entry point for the ws application.

ws_app
ws_client

WebSocket client connect for ws:// / wss:// URLs.

ws_close

Close-code classification and validation (RFC 6455 §7.4).

ws_deflate

RFC 7692 — permessage-deflate extension helpers.

ws_frame

RFC 6455 frame codec.

ws_h1_tcp_server

Reference HTTP/1.1 WebSocket server over gen_tcp.

ws_h1_upgrade

RFC 6455 handshake helpers for WebSocket over HTTP/1.1.

ws_h2_upgrade

RFC 8441 — Bootstrapping WebSockets with HTTP/2.

ws_h3_upgrade

RFC 9220 — Bootstrapping WebSockets with HTTP/3.

ws_handler

User handler behaviour. The session dispatches inbound messages and out-of-band Erlang messages to the callback module supplied at ws:accept/5 / ws:connect/2 time.

ws_session

WebSocket session state machine.

ws_sup
ws_transport

Transport behaviour — a thin abstraction the session uses to exchange bytes on the stream handle supplied by the embedder.

ws_transport_gen_tcp

Reference ws_transport implementation over plain gen_tcp.

ws_transport_ssl

ws_transport implementation over OTP ssl. Used by the client for wss:// URLs. Mirrors ws_transport_gen_tcp in every respect except the module calls and message shape.