Commanded.PubSub.PhoenixPubSub (Commanded v1.3.1) View Source

Pub/sub adapter using Phoenix's distributed pub/sub and presence platform.

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 :my_app, MyApp.Application,
  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 servers

  • Phoenix.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

Link to this function

broadcast(adapter_meta, topic, message)

View Source

Broadcasts message on given topic.

Link to this function

child_spec(application, config)

View Source

Start the configured Phoenix pub/sub adapter and a presence tracker.

Link to this function

list(adapter_meta, topic)

View Source

List tracked terms and associated PIDs for a given topic.

Link to this function

subscribe(adapter_meta, topic)

View Source

Subscribes the caller to the topic.

Link to this function

track(adapter_meta, topic, key)

View Source

Track the current process under the given topic, uniquely identified by key.