Behaviour for cluster-wide messaging.

Implementations handle the mechanics of delivering messages to all nodes in a scope. The configured adapter is resolved via ClusterHelper.Adapter.

Built-in adapters

• ClusterHelper.Broadcast.PG — Erlang :pg process groups (default)

Custom adapters

defmodule MyApp.MyBroadcast do
  @behaviour ClusterHelper.Broadcast

  @impl true
  def start_scope(scope), do: ...
  @impl true
  def join(scope), do: ...
  @impl true
  def leave(scope), do: ...
  @impl true
  def broadcast(scope, message), do: ...
end

Then configure it:

config :cluster_helper, ClusterHelper.Adapter,
  broadcast: MyApp.MyBroadcast