Interface IPubSubOptions

Options to define the behavior of a IPubSubSystem

The Default settings are.

{
  mqttPatternBasedSubscriptions: true,
  forwardChildData: true,
  forwardParentData: true,
  matchTopicsWithoutWildcards: true,
}

Hierarchy

  • IPubSubOptions

Properties

forwardChildData? forwardParentData? matchTopicsWithoutWildcards? mqttPatternBasedSubscriptions?

Properties

Optional forwardChildData

forwardChildData?: boolean

Flag to enable propagation of child data. Defaults to true. This will forward data changes, if a subscriber is listening to 'a/b' and data on 'a/b/c' is changed. The subscriber will receive an object like { ... , c: ... }

If set to false, these changes arent forwarded.

Author

M.Karkowski

Memberof

TPubSubOptions

Optional forwardParentData

forwardParentData?: boolean

Flag to enable the propagation of parent changed data. Defaults to true. This will forward data changes, if a subscriber is listening to 'a/b/c' and data on 'a/b' is changed. The subscriber will get the property c of the published object on 'a/b' (if it exists, otherwise it will receive null)

If set to false, these changes arent forwarded.

Author

M.Karkowski

Memberof

TPubSubOptions

Optional matchTopicsWithoutWildcards

matchTopicsWithoutWildcards?: boolean

If enabled, the topics match without wildcards. (must be enabled for the defined behavior in forwardChildData and forwardParentData)

Author

M.Karkowski

Memberof

TPubSubOptions

Optional mqttPatternBasedSubscriptions

mqttPatternBasedSubscriptions?: boolean

If set to true, subscriptions with patterns will be handled like on mqtt. Otherwise, we will distribute the content more or lesss like on pattern less topic. ('#' and '+' in a topic will cause an exception)

Author

M.Karkowski

Memberof

TPubSubOptions

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc