Skip to main content

MQTTSettings

@webda/cloudevents

Interface: MQTTSettings

Defined in: subscription.ts:23

All implementations that support MQTT MUST support the topicname settings. All other settings SHOULD be supported.

Properties​

expiry?​

optional expiry?: number

Defined in: subscription.ts:45

MQTT expiry interval, in seconds. This value has no default value and the message will not expire if the setting is absent. This setting only applies to MQTT 5.0.

qos?​

optional qos?: number

Defined in: subscription.ts:34

MQTT quality of service (QoS) level: 0 (at most once), 1 (at least once), or 2 (exactly once). This defaults to 1 if not set.

Default​

1

retain?​

optional retain?: boolean

Defined in: subscription.ts:40

MQTT retain flag: true/false. This defaults to false if not set.

Default​

false

topicname​

topicname: string

Defined in: subscription.ts:27

The name of the MQTT topic to publish to.

userproperties?​

optional userproperties?: object

Defined in: subscription.ts:50

A set of key/value pairs that are copied into the MQTT PUBLISH packet's user property section. This setting only applies to MQTT 5.0.

Index Signature​

[key: string]: string