API Reference channel_client v#0.1.1

Connect to Phoenix Channels from Elixir.

A client process bound to one channel topic on a ChannelClient.Socket.

Behaviour for pluggable wire formats.

BTOON — the binary variant of the TOON format.

Erlang External Term Format (:etf), carrying the protocol v2 array shape [join_ref, ref, topic, event, payload].

Phoenix Channels JSON format (the default).

TOON (Token-Oriented Object Notation) wire format — compact, text-based.

A struct representing a single Phoenix channel message.

Phoenix Channels protocol 1.0.0 serializer.

Phoenix Channels protocol 2.0.0 serializer.

A behaviour for pluggable message middleware, modelled after Phoenix's Plug.

Halts the pipeline for messages whose event matches a blocklist.

Logs every message flowing through a pipeline.

A GenServer holding the WebSocket connection to a Phoenix endpoint.

Telemetry events emitted by ChannelClient.

Behaviour for socket transports used by ChannelClient.Socket.

WebSocket transport for ChannelClient.Socket, built on the :websocket_client library.