Commanded v1.0.0 Commanded.PubSub 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

Link to this section Functions

Link to this function

adapter(application, config)

View Source
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.