The one place the websocket handler and HTTP router go through for anything that may need to reach other nodes: broadcasting, presence, and channel occupancy.
It always does the node-local part itself (delivering to sockets
connected to this node via the instance's Registry) and then asks the
configured PusherServer.Backend to carry the rest across the cluster.
With the default Local backend that second step is a no-op, so a
single node behaves exactly as before.
Summary
Functions
Fires the channel_occupied webhook.
Fires the channel_vacated webhook.
Tells the cluster (and the webhook, if configured) that a user joined a presence channel.
Tells the cluster (and the webhook, if configured) that a user's last connection left a presence channel.
The backend module configured for this instance.
Delivers message (a map, or an already-encoded JSON string) to every
subscriber of channel on this node, then to every other node through
the backend. exclude_socket_id is skipped everywhere.
Records a local subscribe. true if the channel just became occupied cluster-wide.
Records a local unsubscribe. true if the channel just became vacant cluster-wide.
Names of every channel with at least one subscriber, across the cluster.
Delivers to this node's subscribers only. Used for messages that arrived from other nodes.
Adds a presence entry. true if this is the user's first connection on the channel, cluster-wide.
Unique members of a presence channel as {user_id, user_info} pairs.
Removes a presence entry. Returns {is_users_last_connection, user_id}.
Silently re-records an already-announced presence entry (used after Redis lost its data).
Total subscribers on channel across the cluster.
Functions
Fires the channel_occupied webhook.
Fires the channel_vacated webhook.
Tells the cluster (and the webhook, if configured) that a user joined a presence channel.
Tells the cluster (and the webhook, if configured) that a user's last connection left a presence channel.
The backend module configured for this instance.
Delivers message (a map, or an already-encoded JSON string) to every
subscriber of channel on this node, then to every other node through
the backend. exclude_socket_id is skipped everywhere.
Records a local subscribe. true if the channel just became occupied cluster-wide.
Records a local unsubscribe. true if the channel just became vacant cluster-wide.
Names of every channel with at least one subscriber, across the cluster.
Delivers to this node's subscribers only. Used for messages that arrived from other nodes.
Adds a presence entry. true if this is the user's first connection on the channel, cluster-wide.
Unique members of a presence channel as {user_id, user_info} pairs.
Removes a presence entry. Returns {is_users_last_connection, user_id}.
Silently re-records an already-announced presence entry (used after Redis lost its data).
Total subscribers on channel across the cluster.