Phoenix.PubSub.Adapter behaviour

Specification to implement a custom PubSub adapter.

Summary

Types

adapter_name()

Callbacks

broadcast(adapter_name, arg2, arg3, arg4): Broadcasts the given topic, message, and dispatcher to all nodes in the cluster (except the current node itself).
child_spec(keyword): Returns a child specification that mounts the processes required for the adapter.
direct_broadcast(adapter_name, arg2, arg3, arg4, arg5): Broadcasts the given topic, message, and dispatcher to given node in the cluster (it may point to itself).
node_name(adapter_name): Returns the node name as an atom or a binary.

Types

adapter_name()

Callbacks

broadcast(adapter_name, arg2, arg3, arg4)

Broadcasts the given topic, message, and dispatcher to all nodes in the cluster (except the current node itself).

child_spec(keyword)

Returns a child specification that mounts the processes required for the adapter.

child_spec will receive all options given Phoenix.PubSub. Note, however, that the :name under options is the name of the complete PubSub system. The name of the process to be used by adapter is under the :adapter_name key.

direct_broadcast(adapter_name, arg2, arg3, arg4, arg5)

Broadcasts the given topic, message, and dispatcher to given node in the cluster (it may point to itself).

node_name(adapter_name)

Returns the node name as an atom or a binary.