Interface SubackPacket

Data model of an MQTT5 SUBACK packet.

Hierarchy

Properties

reasonCodes reasonString? type? userProperties?

Properties

reasonCodes

reasonCodes: SubackReasonCode[]

A list of reason codes indicating the result of each individual subscription entry in the associated SUBSCRIBE packet.

See MQTT5 Suback Payload

Optional reasonString

reasonString?: string

Additional diagnostic information about the result of the SUBSCRIBE attempt.

See MQTT5 Reason String

Optional type

type?: PacketType

Always 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).

Optional userProperties

userProperties?: UserProperty[]

Set of MQTT5 user properties included with the packet.

See MQTT5 User Property

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc