Class SubscriptionManager

Hierarchy

SubscriptionManager

Index

Constructors

Properties

#storage mqtt payload topic

Methods

execute restore save subscribe unsubscribe

Constructors

constructor

new SubscriptionManager(mqtt: RealtimeMqttManager, payload: RealtimePayloadHandler, topic: RealtimeTopic): SubscriptionManager
Parameters
- mqtt: RealtimeMqttManager
- payload: RealtimePayloadHandler
- topic: RealtimeTopic
Returns SubscriptionManager

Properties

`Private` #storage

#storage: Record<string, string[]> = {}

`Private` `Readonly` mqtt

mqtt: RealtimeMqttManager

`Private` `Readonly` payload

payload: RealtimePayloadHandler

`Private` `Readonly` topic

topic: RealtimeTopic

Methods

`Private` execute

execute(input: SubscriptionManagerInput, action: "sub" | "unsub"): Promise<undefined | MqttMessageOutgoing>[]
Either subscribes to or unsubscribes from given subtopics depending on action argument
Parameters
- input: SubscriptionManagerInput
  
  the topics and subtopics
- action: "sub" | "unsub"
  
  determines if you need to subscribe or unsubscribe
Returns Promise<undefined | MqttMessageOutgoing>[]

restore

restore(): Promise<void>
Sends signal to subscribe to all events from the #storage Intended to call after reconnect to easily restore all previous subscriptions

Returns Promise<void>

`Private` save

save(topic: string, subs: string[], action: "sub" | "unsub"): void
Just saves the current subscriptions state in the RAM
Parameters
- topic: string
- subs: string[]
- action: "sub" | "unsub"
Returns void

subscribe

subscribe(input: SubscriptionManagerInput): Promise<undefined | MqttMessageOutgoing>[]
Parameters
- input: SubscriptionManagerInput
Returns Promise<undefined | MqttMessageOutgoing>[]

unsubscribe

unsubscribe(input: SubscriptionManagerInput): Promise<undefined | MqttMessageOutgoing>[]
Parameters
- input: SubscriptionManagerInput
Returns Promise<undefined | MqttMessageOutgoing>[]