DistributedPubSub
Defined in: src/cluster/pubsub/DistributedPubSubExtension.ts:27
System-wide access to the DistributedPubSubMediator for a given Cluster.
Call DistributedPubSub.get(system, cluster).mediator to grab a ref
and send Subscribe / Publish / … messages to it.
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new DistributedPubSub(
system):DistributedPubSub
Defined in: src/cluster/pubsub/DistributedPubSubExtension.ts:31
Parameters
Section titled “Parameters”system
Section titled “system”Returns
Section titled “Returns”DistributedPubSub
Accessors
Section titled “Accessors”mediator
Section titled “mediator”Get Signature
Section titled “Get Signature”get mediator():
ActorRef<MediatorMessage>
Defined in: src/cluster/pubsub/DistributedPubSubExtension.ts:59
The ref of the mediator — throws if start() hasn’t been called.
Returns
Section titled “Returns”ActorRef<MediatorMessage>
Methods
Section titled “Methods”isStarted()
Section titled “isStarted()”isStarted():
boolean
Defined in: src/cluster/pubsub/DistributedPubSubExtension.ts:64
Returns
Section titled “Returns”boolean
start()
Section titled “start()”start(
cluster,settings?):ActorRef<MediatorMessage>
Defined in: src/cluster/pubsub/DistributedPubSubExtension.ts:38
Bind the mediator to a specific Cluster. Idempotent per Cluster — re-binding to the same cluster is a no-op; re-binding to a different cluster throws.
Parameters
Section titled “Parameters”cluster
Section titled “cluster”settings?
Section titled “settings?”Partial<Omit<DistributedPubSubSettings, "cluster">> = {}
Returns
Section titled “Returns”ActorRef<MediatorMessage>