MQTTAsync_createOptions(3)

NAME
MQTTAsync_createOptions

SYNOPSIS

#include <MQTTAsync.h>

  Data Fields
char struct_id [4]
int struct_version
int sendWhileDisconnected
int maxBufferedMessages
int MQTTVersion
int allowDisconnectedSendAtAnyTime
int deleteOldestMessages
int restoreMessages
int persistQoS0

Detailed Description

Options for the MQTTAsync_createWithOptions call

Field Documentation

  char struct_id[4]
The eyecatcher for this structure. must be MQCO.

  int struct_version
The version number of this structure. Must be 0, 1, 2 or 3 0 means no MQTTVersion 1 means no allowDisconnectedSendAtAnyTime, deleteOldestMessages, restoreMessages 2 means no persistQoS0

  int sendWhileDisconnected
Whether to allow messages to be sent when the client library is not connected.

  int maxBufferedMessages
The maximum number of messages allowed to be buffered. This is intended to be used to limit the number of messages queued while the client is not connected. It also applies when the client is connected, however, so has to be greater than 0.

  int MQTTVersion
Whether the MQTT version is 3.1, 3.1.1, or 5. To use V5, this must be set. MQTT V5 has to be chosen here, because during the create call the message persistence is initialized, and we want to know whether the format of any persisted messages is appropriate for the MQTT version we are going to connect with. Selecting 3.1 or 3.1.1 and attempting to read 5.0 persisted messages will result in an error on create.

  int allowDisconnectedSendAtAnyTime
Allow sending of messages while disconnected before a first successful connect.

  int deleteOldestMessages

  int restoreMessages

  int persistQoS0

Author

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