#include <MQTTAsync.h>
Public Attributes | |
| const char * | message |
| struct { | |
| const void * data | |
| int len | |
| } | payload |
| int | qos |
| int | retained |
| char | struct_id [4] |
| int | struct_version |
| const char * | topicName |
MQTTAsync_willOptions defines the MQTT "Last Will and Testament" (LWT) settings for the client. In the event that a client unexpectedly loses its connection to the server, the server publishes the LWT message to the LWT topic on behalf of the client. This allows other clients (subscribed to the LWT topic) to be made aware that the client has disconnected. To enable the LWT function for a specific client, a valid pointer to an MQTTAsync_willOptions structure is passed in the MQTTAsync_connectOptions structure used in the MQTTAsync_connect() call that connects the client to the server. The pointer to MQTTAsync_willOptions can be set to NULL if the LWT function is not required.
Definition at line 985 of file MQTTAsync.h.
| const void* MQTTAsync_willOptions::data |
binary payload data
Definition at line 1010 of file MQTTAsync.h.
| int MQTTAsync_willOptions::len |
binary payload length
Definition at line 1009 of file MQTTAsync.h.
| const char* MQTTAsync_willOptions::message |
The LWT payload.
Definition at line 996 of file MQTTAsync.h.
| struct { ... } MQTTAsync_willOptions::payload |
The LWT payload in binary form. This is only checked and used if the message option is NULL
| int MQTTAsync_willOptions::qos |
The quality of service setting for the LWT message (see MQTTAsync_message.qos and qos).
Definition at line 1005 of file MQTTAsync.h.
| int MQTTAsync_willOptions::retained |
The retained flag for the LWT message (see MQTTAsync_message.retained).
Definition at line 1000 of file MQTTAsync.h.
| char MQTTAsync_willOptions::struct_id[4] |
The eyecatcher for this structure. must be MQTW.
Definition at line 988 of file MQTTAsync.h.
| int MQTTAsync_willOptions::struct_version |
The version number of this structure. Must be 0 or 1 0 indicates no binary will message support
Definition at line 992 of file MQTTAsync.h.
| const char* MQTTAsync_willOptions::topicName |
The LWT topic to which the LWT message will be published.
Definition at line 994 of file MQTTAsync.h.