Commanded v1.0.0-rc.0 Commanded.PubSub behaviour View Source
Pub/sub behaviour for use by Commanded to subcribe to and broadcast messages.
Link to this section Summary
Functions
Get the configured pub/sub adapter.
Callbacks
Broadcasts message on given topic.
Return an optional supervisor spec for pub/sub.
List tracked PIDs for a given topic.
Subscribes the caller to the PubSub adapter's topic.
Track the current process under the given topic
, uniquely identified by
key
.
Link to this section Types
Link to this section Functions
Link to this function
pubsub_provider(application, config)
View Sourcepubsub_provider(application(), config :: Keyword.t()) :: module()
Get the configured pub/sub adapter.
Defaults to a local pub/sub, restricted to running on a single node.
Link to this section Callbacks
Broadcasts message on given topic.
topic
- The topic to broadcast to, ie:"users:123"
message
- The payload of the broadcast
Link to this callback
child_spec(pubsub, config)
View Sourcechild_spec(pubsub(), config :: Keyword.t()) :: [:supervisor.child_spec()]
Return an optional supervisor spec for pub/sub.
List tracked PIDs for a given topic.
Subscribes the caller to the PubSub adapter's topic.
Track the current process under the given topic
, uniquely identified by
key
.