MQTTAsync_successData5 - Man Page

Synopsis

#include <MQTTAsync.h>

Data Fields

char struct_id [4]
int struct_version
MQTTAsync_token token
enum MQTTReasonCodes reasonCode
MQTTProperties properties
union {
  struct {
     int reasonCodeCount
     enum MQTTReasonCodes * reasonCodes
  } sub
  struct {
     MQTTAsync_message message
     char * destinationName
  } pub
  struct {
     char * serverURI
     int MQTTVersion
     int sessionPresent
  } connect
  struct {
     int reasonCodeCount
     enum MQTTReasonCodes * reasonCodes
  } unsub
} alt

Detailed Description

The data returned on completion of a successful API call in the response callback onSuccess.

Field Documentation

char struct_id[4]

The eyecatcher for this structure. Will be MQSD.

int struct_version

The version number of this structure. Will be 0

MQTTAsync_token token

A token identifying the successful request. Can be used to refer to the request later.

enum MQTTReasonCodes reasonCode

MQTT V5 reason code returned

MQTTProperties properties

MQTT V5 properties returned, if any

int reasonCodeCount

the number of reason codes in the reasonCodes array

enum MQTTReasonCodes* reasonCodes

an array of reasonCodes

struct  { ... }  sub

For subscribeMany, the list of reasonCodes returned by the server.

MQTTAsync_message message

the message being sent to the server

char* destinationName

the topic destination for the message

struct  { ... }  pub

For publish, the message being sent to the server.

char* serverURI

the connection string of the server

int MQTTVersion

the version of MQTT being used

int sessionPresent

the session present flag returned from the server

struct  { ... }  connect

struct  { ... }  unsub

For unsubscribeMany, the list of reasonCodes returned by the server.

union  { ... }  alt

A union of the different values that can be returned for subscribe, unsubscribe and publish.

Author

Generated automatically by Doxygen for Paho Asynchronous MQTT C Client Library from the source code.

Info

Tue Sep 14 2021 Paho Asynchronous MQTT C Client Library