Public Attributes | List of all members
MQTTAsync_responseOptions Struct Reference

#include <MQTTAsync.h>

Public Attributes

void * context
 
MQTTAsync_onFailureonFailure
 
MQTTAsync_onFailure5onFailure5
 
MQTTAsync_onSuccessonSuccess
 
MQTTAsync_onSuccess5onSuccess5
 
MQTTProperties properties
 
char struct_id [4]
 
int struct_version
 
MQTTSubscribe_options subscribeOptions
 
int subscribeOptionsCount
 
MQTTSubscribe_optionssubscribeOptionsList
 
MQTTAsync_token token
 

Detailed Description

Structure to define call options. For MQTT 5.0 there is input data as well as that describing the response method. So there is now also a synonym MQTTAsync_callOptions to better reflect the use. This responseOptions name is kept for backward compatibility.

Definition at line 684 of file MQTTAsync.h.

Member Data Documentation

void* MQTTAsync_responseOptions::context

A pointer to any application-specific context. The the context pointer is passed to success or failure callback functions to provide access to the context information in the callback.

Definition at line 708 of file MQTTAsync.h.

MQTTAsync_onFailure* MQTTAsync_responseOptions::onFailure

A pointer to a callback function to be called if the API call fails. Can be set to NULL, in which case no indication of unsuccessful completion will be received.

Definition at line 702 of file MQTTAsync.h.

MQTTAsync_onFailure5* MQTTAsync_responseOptions::onFailure5

A pointer to a callback function to be called if the API call successfully completes. Can be set to NULL, in which case no indication of successful completion will be received.

Definition at line 726 of file MQTTAsync.h.

MQTTAsync_onSuccess* MQTTAsync_responseOptions::onSuccess

A pointer to a callback function to be called if the API call successfully completes. Can be set to NULL, in which case no indication of successful completion will be received.

Definition at line 696 of file MQTTAsync.h.

MQTTAsync_onSuccess5* MQTTAsync_responseOptions::onSuccess5

A pointer to a callback function to be called if the API call successfully completes. Can be set to NULL, in which case no indication of successful completion will be received.

Definition at line 720 of file MQTTAsync.h.

MQTTProperties MQTTAsync_responseOptions::properties

MQTT V5 input properties

Definition at line 730 of file MQTTAsync.h.

char MQTTAsync_responseOptions::struct_id[4]

The eyecatcher for this structure. Must be MQTR

Definition at line 687 of file MQTTAsync.h.

int MQTTAsync_responseOptions::struct_version

The version number of this structure. Must be 0 or 1 if 0, no MQTTV5 options

Definition at line 690 of file MQTTAsync.h.

MQTTSubscribe_options MQTTAsync_responseOptions::subscribeOptions

Definition at line 734 of file MQTTAsync.h.

int MQTTAsync_responseOptions::subscribeOptionsCount

Definition at line 739 of file MQTTAsync.h.

MQTTSubscribe_options* MQTTAsync_responseOptions::subscribeOptionsList

Definition at line 743 of file MQTTAsync.h.

MQTTAsync_token MQTTAsync_responseOptions::token

A token is returned from the call. It can be used to track the state of this request, both in the callbacks and in future calls such as MQTTAsync_waitForCompletion.

Definition at line 714 of file MQTTAsync.h.


The documentation for this struct was generated from the following file:


plotjuggler
Author(s): Davide Faconti
autogenerated on Sun Dec 6 2020 04:02:49