phoenix_pubsub v2.0.0 Phoenix.PubSub.Adapter behaviour View Source

Specification to implement a custom PubSub adapter.

Link to this section Summary

Types

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.

Link to this section Types

adapter_name()

adapter_name() :: atom()

Link to this section Callbacks

broadcast(adapter_name, arg2, arg3, arg4)

broadcast(
  adapter_name(),
  Phoenix.PubSub.topic(),
  Phoenix.PubSub.message(),
  Phoenix.PubSub.dispatcher()
) :: :ok | {:error, term()}

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

child_spec(keyword)

child_spec(keyword()) :: Supervisor.child_spec()

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)

direct_broadcast(
  adapter_name(),
  Phoenix.PubSub.node_name(),
  Phoenix.PubSub.topic(),
  Phoenix.PubSub.message(),
  Phoenix.PubSub.dispatcher()
) :: :ok | {:error, term()}

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

node_name(adapter_name)

node_name(adapter_name()) :: Phoenix.PubSub.node_name()

Returns the node name as an atom or a binary.