Packages
commanded
1.0.0-rc.0
1.4.10
1.4.9
1.4.8
1.4.7
1.4.6
1.4.3
1.4.2
1.4.1
1.4.0
1.4.0-rc.0
1.3.1
1.3.0
1.2.0
1.1.1
1.1.0
1.0.1
1.0.0
1.0.0-rc.1
1.0.0-rc.0
0.19.1
0.19.0
0.18.1
0.18.0
0.17.5
0.17.4
0.17.3
0.17.2
0.17.1
0.17.0
0.16.0
0.16.0-rc.1
0.16.0-rc.0
0.15.1
0.15.0
0.14.0
0.14.0-rc.0
0.13.0
0.12.0
0.11.0
0.10.0
0.9.0
0.8.5
0.8.4
0.8.3
0.8.1
0.8.0
0.7.1
0.6.2
0.6.1
0.6.0
0.4.0
0.3.1
0.3.0
0.2.1
0.2.0
0.1.0
Use Commanded to build your own Elixir applications following the CQRS/ES pattern.
Current section
Files
Jump to
Current section
Files
lib/commanded/pubsub/adapter.ex
defmodule Commanded.PubSub.Adapter do
@moduledoc false
defmacro __using__(opts) do
quote bind_quoted: [opts: opts] do
@adapter Keyword.fetch!(opts, :adapter)
@behaviour Commanded.PubSub.Adapter
def child_spec(config), do: @adapter.child_spec(__MODULE__, config)
def subscribe(topic), do: @adapter.subscribe(__MODULE__, topic)
def broadcast(topic, message), do: @adapter.broadcast(__MODULE__, topic, message)
def track(topic, key), do: @adapter.broadcast(__MODULE__, topic, key)
def list(topic), do: @adapter.list(__MODULE__, topic)
end
end
@doc """
Return an optional supervisor spec for pub/sub.
"""
@callback child_spec(config :: Keyword.t()) :: [:supervisor.child_spec()]
@doc """
Subscribes the caller to the PubSub topic.
"""
@callback subscribe(topic :: String.t()) :: :ok | {:error, term}
@doc """
Broadcasts message on given topic.
* `topic` - The topic to broadcast to, ie: `"users:123"`
* `message` - The payload of the broadcast
"""
@callback broadcast(topic :: String.t(), message :: term) :: :ok | {:error, term}
@doc """
Track the current process under the given `topic`, uniquely identified by
`key`.
"""
@callback track(String.t(), key :: term) :: :ok | {:error, term}
@doc """
List tracked PIDs for a given topic.
"""
@callback list(String.t()) :: [{term, pid}]
end