API reference

This reference uses Gleam docs metadata for beryl, beryl_ewe, and beryl_mist.

`beryl` `0.5.0`

beryl
beryl: type-safe real-time communication
beryl/bridge
Forward an external OTP actor's message stream to a socket through its Sender.
beryl/channel
The channel composition surface: a channel is a topic pattern paired with a typed join callback and callbacks over private state.
beryl/error
Shared beryl-owned error helpers.
beryl/group
Topic groups
beryl/overload
Admission limits for local beryl work.
beryl/presence
Distributed presence tracking with a CRDT
beryl/presence/wire
Phoenix-compatible wire encoding for presence diffs.
beryl/pubsub
Distributed PubSub with Erlang pg
beryl/snapshot
A point-in-time snapshot of local runtime state.
beryl/socket
Types for building app-side dispatch systems with beryl.child_spec.
beryl/topic
Pattern matching for topic routing.
beryl/transport
Transport SPI: the contract between beryl core and WebSocket transport implementations such as the beryl_mist and beryl_ewe packages.
beryl/transport/origin
Origin and handshake-version checks for WebSocket upgrades.
beryl/transport/server
Server-agnostic WebSocket transport infrastructure.
beryl/wire
Phoenix wire protocol: encoding and decoding helpers and the canonical phoenix_codec() for beryl/wire/codec.
beryl/wire/codec
Pluggable wire codec for beryl.