Commanded v0.18.1 Commanded.PubSub.PhoenixPubSub View Source
Pub/sub adapter using Phoenix's distributed pub/sub and presence platform [1].
[1] https://hex.pm/packages/phoenix_pubsub
To use Phoenix pub/sub you must add it as a dependency in your project's
mix.exs
file:
defp deps do
[
{:phoenix_pubsub, "~> 1.0"}
]
end
Fetch mix deps and configure the pubsub settings in your environment config file:
# `config/config.exs`
config :commanded, pubsub: [
phoenix_pubsub: [
adapter: Phoenix.PubSub.PG2,
pool_size: 1
]
]
Specify the Phoenix pub/sub adapter you wish to use from:
Phoenix.PubSub.PG2
- uses Distributed Elixir, directly exchanging notifications between serversPhoenix.PubSub.Redis
- uses Redis to exchange data between servers
Link to this section Summary
Functions
Broadcasts message on given topic.
Start the configured Phoenix pub/sub adapter and a presence tracker.
List tracked terms and associated PIDs for a given topic.
Subscribes the caller to the topic.
Track the current process under the given topic
, uniquely identified by
key
.
Link to this section Functions
broadcast(topic, message) View Source
Broadcasts message on given topic.
child_spec()
View Source
child_spec() :: [:supervisor.child_spec()]
child_spec() :: [:supervisor.child_spec()]
Start the configured Phoenix pub/sub adapter and a presence tracker.
list(topic) View Source
List tracked terms and associated PIDs for a given topic.
subscribe(topic) View Source
Subscribes the caller to the topic.
track(topic, key) View Source
Track the current process under the given topic
, uniquely identified by
key
.