Repository navigation
v0.1.0
2026-02-27
Features
- Callback API — Define a module with
use Parleyand implementhandle_connect/1,handle_frame/2, andhandle_disconnect/2 - Callback return types — Callbacks support
{:ok, state},{:push, frame, state}to send a frame inline, and{:stop, reason, state}to stop the process - Supervision-ready —
child_spec/1,start_link/2, and name registration (local, global, via) work likeGenServer - Automatic frame queuing — Frames sent via
send_frame/2during the connecting handshake are postponed and delivered once connected - Close frame handling — Server-initiated close frames trigger a proper close handshake before disconnecting
- Connect timeout — Configurable
:connect_timeoutoption for the WebSocket upgrade handshake (default: 10s) - Process stays alive on errors — Stream errors, decode errors, and timeouts transition to
:disconnectedwithout stopping the process
Documentation
- Connection lifecycle state diagram (Mermaid)
- Full
@doc,@spec, and@typedoccoverage on the public API - README with installation, quick-start, and callback reference
New Contributors
Full Changelog: https://github.com/joaop21/parley/commits/v0.1.0