Sent publishes - The topic this message should be published to.
Received publishes - The topic this message was published to.
See MQTT5 Topic Name
Optional payloadThe payload of the publish message.
Sent publishes - The MQTT quality of service level this message should be delivered with.
Received publishes - The MQTT quality of service level this message was delivered at.
See MQTT5 QoS
Optional retainTrue if this is a retained message, false otherwise.
Always set on received publishes; on sent publishes, undefined implies false.
See MQTT5 Retain
Optional payloadProperty specifying the format of the payload data. The mqtt5 client does not enforce or use this value in a meaningful way.
Optional messageSent publishes - indicates the maximum amount of time allowed to elapse for message delivery before the server should instead delete the message (relative to a recipient).
Received publishes - indicates the remaining amount of time (from the server's perspective) before the message would have been deleted relative to the subscribing client.
If left undefined, indicates no expiration timeout.
Optional topicSent publishes - (Node only) topic alias to use, if possible, when encoding this packet. Only used if the client's outbound topic aliasing mode is set to Manual.
Received publishes - topic alias used by the server when transmitting the publish to the client.
Optional responseOpaque topic string intended to assist with request/response implementations. Not internally meaningful to MQTT5 or this client.
Optional correlationOpaque binary data used to correlate between publish messages, as a potential method for request-response implementation. Not internally meaningful to MQTT5.
Optional subscriptionSent publishes - ignored
Received publishes - the subscription identifiers of all the subscriptions this message matched.
Optional contentProperty specifying the content type of the payload. Not internally meaningful to MQTT5.
Optional userSet of MQTT5 user properties included with the packet.
Optional typeAlways set on packets coming from the client to the user. Ignored if set on packets that come from the user to the client.
The primary use is to allow users to distinguish between packets in polymorphic situations (for example, the result of a publish attempt which might be a Puback (QoS 1) or Pubcomp (QoS 2, when we support it).
Generated using TypeDoc
Data model of an MQTT5 PUBLISH packet