Overview
Classes: ConnectionEstablishedEvent, ConnectionInfo, ConnectionLostEvent, DisconnectedEvent, IMQTTClient, MQTTClient, MQTTClientEventDispatcher, MQTTClientRemoteObject, MQTTClientServerHelper, MQTTClientSkeleton, Message, MessageArrivedEvent, MessageDeliveredEvent, MessagePublishedEvent, Property, PublishResult, Response, Statistics, SubscribeOptions, TopicCount, TopicQoS
Classes
struct ConnectionEstablishedEvent
Event arguments for MQTTClient::connected.
struct ConnectionInfo
struct ConnectionLostEvent
Event arguments for MQTTClient::connectionLost.
struct DisconnectedEvent
Event arguments for MQTT5Client::disconnected.
class IMQTTClient
The interface for MQTT clients.
class MQTTClient
The interface for MQTT clients.
class MQTTClientEventDispatcher
The interface for MQTT clients.
class MQTTClientRemoteObject
The interface for MQTT clients.
class MQTTClientServerHelper
The interface for MQTT clients.
class MQTTClientSkeleton
The interface for MQTT clients.
struct Message
This structure encapsulates a MQTT message.
struct MessageArrivedEvent
Event arguments for MQTTClient::messageArrived.
struct MessageDeliveredEvent
Event arguments for MQTTClient::messageDelivered.
struct MessagePublishedEvent
The MQTT V5 version of MessageDeliveredEvent.
struct Property
struct PublishResult
The result of a MQTT V5 publish operation.
struct Response
struct Statistics
struct SubscribeOptions
MQTT V5 Subscribe Options
struct TopicCount
struct TopicQoS
A vector of these is given to MQTTClient::subscribeMany.
Enumerations
MQTTVersion
MQTT protocol version numbers.
MQTT_VERSION_3_1 = 3
MQTT_VERSION_5 = 5
PropertyID
A Property consists of an identifier which defines its usage and data type, followed by a value.
Property identifiers are defined in the MQTT V5 specification.
PROP_PAYLOAD_FORMAT_INDICATOR = 1
Payload Format Indicator (byteValue)
PROP_MESSAGE_EXPIRY_INTERVAL = 2
Message Expiry Interval (uint32Value)
Content Type (stringValue)
Response Topic (stringValue)
Correlation Data (binaryValue)
PROP_SUBSCRIPTION_IDENTIFIER = 11
Subscription Identifier (uint32Value)
PROP_SESSION_EXPIRY_INTERVAL = 17
Session Expiry Interval (uint32Value)
PROP_ASSIGNED_CLIENT_IDENTIFER = 18
Assigned Client Identifier (stringValue)
Server Keep Alive (uint16Value)
PROP_AUTHENTICATION_METHOD = 21
Authentication Method (stringValue)
Authentication Data (binaryValue)
PROP_REQUEST_PROBLEM_INFORMATION = 23
Request Problem Information (byteValue)
Will Delay Interval (uint32Value)
PROP_REQUEST_RESPONSE_INFORMATION = 25
Request Response Information (stringValue)
PROP_RESPONSE_INFORMATION = 26
Response Information (stringValue)
Server Reference(stringValue)
PROP_REASON_STRING = 31
Reason String(string16Value)
PROP_RECEIVE_MAXIMUM = 33
Receive Maximum (uint16Value)
Topic Alias Maximum (uint16Value)
PROP_TOPIC_ALIAS = 35
Topic Alias (uint16Value)
PROP_MAXIMUM_QOS = 36
Maximum QoS (byteValue)
Retain Available (byteValue)
PROP_USER_PROPERTY = 38
User property (name, stringValue)
Maximum Packet Size (uint32Value)
PROP_WILDCARD_SUBSCRIPTION_AVAILABLE = 40
Wildcard Subscription Available (byteValue)
PROP_SUBSCRIPTION_IDENTIFIERS_AVAILABLE = 41
Subscription Identifiers Available (byteValue)
PROP_SHARED_SUBSCRIPTION_AVAILABLE = 42
Shared Subscription Available (byteValue)
ReasonCode
MQTT V5 Reason Codes
REASON_SUCCESS = 0
REASON_NORMAL_DISCONNECTION = 0
REASON_DISCONNECT_WITH_WILL_MESSAGE = 4
REASON_NO_MATCHING_SUBSCRIBERS = 16
REASON_NO_SUBSCRIPTION_FOUND = 17
REASON_CONTINUE_AUTHENTICATION = 24
REASON_UNSPECIFIED_ERROR = 128
REASON_MALFORMED_PACKET = 129
REASON_PROTOCOL_ERROR = 130
REASON_IMPLEMENTATION_SPECIFIC_ERROR = 131
REASON_UNSUPPORTED_PROTOCOL_VERSION = 132
REASON_CLIENT_IDENTIFIER_NOT_VALID = 133
REASON_BAD_USER_NAME_OR_PASSWORD = 134
REASON_NOT_AUTHORIZED = 135
REASON_SERVER_UNAVAILABLE = 136
REASON_SERVER_BUSY = 137
REASON_BANNED = 138
REASON_SERVER_SHUTTING_DOWN = 139
REASON_BAD_AUTHENTICATION_METHOD = 140
REASON_KEEP_ALIVE_TIMEOUT = 141
REASON_SESSION_TAKEN_OVER = 142
REASON_TOPIC_FILTER_INVALID = 143
REASON_TOPIC_NAME_INVALID = 144
REASON_PACKET_IDENTIFIER_IN_USE = 145
REASON_PACKET_IDENTIFIER_NOT_FOUND = 146
REASON_RECEIVE_MAXIMUM_EXCEEDED = 147
REASON_TOPIC_ALIAS_INVALID = 148
REASON_PACKET_TOO_LARGE = 149
REASON_MESSAGE_RATE_TOO_HIGH = 150
REASON_QUOTA_EXCEEDED = 151
REASON_ADMINISTRATIVE_ACTION = 152
REASON_PAYLOAD_FORMAT_INVALID = 153
REASON_RETAIN_NOT_SUPPORTED = 154
REASON_QOS_NOT_SUPPORTED = 155
REASON_USE_ANOTHER_SERVER = 156
REASON_SERVER_MOVED = 157
REASON_SHARED_SUBSCRIPTIONS_NOT_SUPPORTED = 158
REASON_CONNECTION_RATE_EXCEEDED = 159
REASON_MAXIMUM_CONNECT_TIME = 160
REASON_SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED = 161
REASON_WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED = 162