Commanded.PubSub (Commanded v1.3.1) View Source

Use the pubsub configured for a Commanded application.

Link to this section Summary

Functions

Get the configured pub/sub adapter.

Broadcasts message on given topic.

Subscribes the caller to the PubSub adapter's topic.

Link to this section Types

Specs

application() :: Commanded.Application.t()

Specs

config() :: Keyword.t() | atom()

Link to this section Functions

Link to this function

adapter(application, config)

View Source

Specs

adapter(application(), config()) :: {module(), config()}

Get the configured pub/sub adapter.

Defaults to a local pub/sub, restricted to running on a single node.

Link to this function

broadcast(application, topic, message)

View Source

Broadcasts message on given topic.

  • topic - The topic to broadcast to, ie: "users:123"
  • message - The payload of the broadcast
Link to this function

subscribe(application, topic)

View Source

Subscribes the caller to the PubSub adapter's topic.