 |
Paho Asynchronous MQTT C Client Library
|
Go to the documentation of this file.
88 #if !defined(MQTTASYNC_H)
91 #if defined(__cplusplus)
100 #include "MQTTExportDeclarations.h"
105 #if !defined(NO_PERSISTENCE)
113 #define MQTTASYNC_SUCCESS 0
118 #define MQTTASYNC_FAILURE -1
122 #define MQTTASYNC_PERSISTENCE_ERROR -2
127 #define MQTTASYNC_DISCONNECTED -3
132 #define MQTTASYNC_MAX_MESSAGES_INFLIGHT -4
136 #define MQTTASYNC_BAD_UTF8_STRING -5
140 #define MQTTASYNC_NULL_PARAMETER -6
146 #define MQTTASYNC_TOPICNAME_TRUNCATED -7
151 #define MQTTASYNC_BAD_STRUCTURE -8
155 #define MQTTASYNC_BAD_QOS -9
159 #define MQTTASYNC_NO_MORE_MSGIDS -10
163 #define MQTTASYNC_OPERATION_INCOMPLETE -11
167 #define MQTTASYNC_MAX_BUFFERED_MESSAGES -12
171 #define MQTTASYNC_SSL_NOT_SUPPORTED -13
177 #define MQTTASYNC_BAD_PROTOCOL -14
181 #define MQTTASYNC_BAD_MQTT_OPTION -15
185 #define MQTTASYNC_WRONG_MQTT_VERSION -16
189 #define MQTTASYNC_0_LEN_WILL_TOPIC -17
195 #define MQTTASYNC_COMMAND_IGNORED -18
199 #define MQTTVERSION_DEFAULT 0
203 #define MQTTVERSION_3_1 3
207 #define MQTTVERSION_3_1_1 4
211 #define MQTTVERSION_5 5
215 #define MQTT_BAD_SUBSCRIBE 0x80
231 #define MQTTAsync_init_options_initializer { {'M', 'Q', 'T', 'G'}, 0, 0 }
324 #define MQTTAsync_message_initializer { {'M', 'Q', 'T', 'M'}, 1, 0, NULL, 0, 0, 0, 0, MQTTProperties_initializer }
479 #define MQTTAsync_connectData_initializer {{'M', 'Q', 'C', 'D'}, 0, NULL, {0, NULL}}
557 #define MQTTAsync_failureData5_initializer {{'M', 'Q', 'F', 'D'}, 0, 0, MQTTREASONCODE_SUCCESS, MQTTProperties_initializer, 0, NULL, 0}
630 #define MQTTAsync_successData5_initializer {{'M', 'Q', 'S', 'D'}, 0, 0, MQTTREASONCODE_SUCCESS, MQTTProperties_initializer, {.sub={0,0}}}
760 #define MQTTAsync_responseOptions_initializer { {'M', 'Q', 'T', 'R'}, 1, NULL, NULL, 0, 0, NULL, NULL, MQTTProperties_initializer, MQTTSubscribe_options_initializer, 0, NULL}
764 #define MQTTAsync_callOptions_initializer MQTTAsync_responseOptions_initializer
938 int persistence_type,
void* persistence_context);
979 #define MQTTAsync_createOptions_initializer { {'M', 'Q', 'C', 'O'}, 2, 0, 100, MQTTVERSION_DEFAULT, 0, 0, 1, 1}
981 #define MQTTAsync_createOptions_initializer5 { {'M', 'Q', 'C', 'O'}, 2, 0, 100, MQTTVERSION_5, 0, 0, 1, 1}
1028 #define MQTTAsync_willOptions_initializer { {'M', 'Q', 'T', 'W'}, 1, NULL, NULL, 0, 0, { 0, NULL } }
1030 #define MQTT_SSL_VERSION_DEFAULT 0
1031 #define MQTT_SSL_VERSION_TLS_1_0 1
1032 #define MQTT_SSL_VERSION_TLS_1_1 2
1033 #define MQTT_SSL_VERSION_TLS_1_2 3
1114 int (*ssl_error_cb) (
const char *str,
size_t len,
void *u);
1127 unsigned int (*ssl_psk_cb) (
const char *hint,
char *identity,
unsigned int max_identity_len,
unsigned char *psk,
unsigned int max_psk_len,
void *u);
1158 #define MQTTAsync_SSLOptions_initializer { {'M', 'Q', 'T', 'S'}, 5, NULL, NULL, NULL, NULL, NULL, 1, MQTT_SSL_VERSION_DEFAULT, 0, NULL, NULL, NULL, NULL, NULL, 0, NULL, 0 }
1358 #define MQTTAsync_connectOptions_initializer { {'M', 'Q', 'T', 'C'}, 8, 60, 1, 65535, NULL, NULL, NULL, 30, 0,\
1359 NULL, NULL, NULL, NULL, 0, NULL, MQTTVERSION_DEFAULT, 0, 1, 60, {0, NULL}, 0, NULL, NULL, NULL, NULL, NULL, NULL, NULL}
1361 #define MQTTAsync_connectOptions_initializer5 { {'M', 'Q', 'T', 'C'}, 8, 60, 0, 65535, NULL, NULL, NULL, 30, 0,\
1362 NULL, NULL, NULL, NULL, 0, NULL, MQTTVERSION_5, 0, 1, 60, {0, NULL}, 1, NULL, NULL, NULL, NULL, NULL, NULL, NULL}
1364 #define MQTTAsync_connectOptions_initializer_ws { {'M', 'Q', 'T', 'C'}, 8, 45, 1, 65535, NULL, NULL, NULL, 30, 0,\
1365 NULL, NULL, NULL, NULL, 0, NULL, MQTTVERSION_DEFAULT, 0, 1, 60, {0, NULL}, 0, NULL, NULL, NULL, NULL, NULL, NULL, NULL}
1367 #define MQTTAsync_connectOptions_initializer5_ws { {'M', 'Q', 'T', 'C'}, 8, 45, 0, 65535, NULL, NULL, NULL, 30, 0,\
1368 NULL, NULL, NULL, NULL, 0, NULL, MQTTVERSION_5, 0, 1, 60, {0, NULL}, 1, NULL, NULL, NULL, NULL, NULL, NULL, NULL}
1445 #define MQTTAsync_disconnectOptions_initializer { {'M', 'Q', 'T', 'D'}, 0, 0, NULL, NULL, NULL,\
1446 MQTTProperties_initializer, MQTTREASONCODE_SUCCESS, NULL, NULL }
1448 #define MQTTAsync_disconnectOptions_initializer5 { {'M', 'Q', 'T', 'D'}, 1, 0, NULL, NULL, NULL,\
1449 MQTTProperties_initializer, MQTTREASONCODE_SUCCESS, NULL, NULL }
1566 LIBMQTT_API
int MQTTAsync_send(
MQTTAsync handle,
const char* destinationName,
int payloadlen,
const void* payload,
int qos,
1616 #define MQTTASYNC_TRUE 1
2345 #if defined(__cplusplus)
int MQTTAsync_isConnected(MQTTAsync handle)
unsigned int protos_len
Definition: MQTTAsync.h:1155
int MQTTAsync_waitForCompletion(MQTTAsync handle, MQTTAsync_token token, unsigned long timeout)
int * qosList
Definition: MQTTAsync.h:572
const MQTTAsync_nameValue * httpHeaders
Definition: MQTTAsync.h:1346
void * context
Definition: MQTTAsync.h:722
int sessionPresent
Definition: MQTTAsync.h:619
int MQTTAsync_token
Definition: MQTTAsync.h:253
int MQTTVersion
Definition: MQTTAsync.h:583
int allowDisconnectedSendAtAnyTime
Definition: MQTTAsync.h:964
int MQTTVersion
Definition: MQTTAsync.h:960
int MQTTAsync_setDisconnected(MQTTAsync handle, void *context, MQTTAsync_disconnected *co)
int MQTTAsync_createWithOptions(MQTTAsync *handle, const char *serverURI, const char *clientId, int persistence_type, void *persistence_context, MQTTAsync_createOptions *options)
int struct_version
Definition: MQTTAsync.h:950
MQTTAsync_nameValue * MQTTAsync_getVersionInfo(void)
int MQTTAsync_subscribe(MQTTAsync handle, const char *topic, int qos, MQTTAsync_responseOptions *response)
void * MQTTAsync
Definition: MQTTAsync.h:243
const char * httpProxy
Definition: MQTTAsync.h:1350
int struct_version
Definition: MQTTAsync.h:1186
char * serverURI
Definition: MQTTAsync.h:582
int sessionPresent
Definition: MQTTAsync.h:584
int do_openssl_init
Definition: MQTTAsync.h:228
void MQTTAsync_setTraceCallback(MQTTAsync_traceCallback *callback)
int MQTTAsync_setMessageArrivedCallback(MQTTAsync handle, void *context, MQTTAsync_messageArrived *ma)
Definition: MQTTAsync.h:591
void MQTTAsync_deliveryComplete(void *context, MQTTAsync_token token)
Definition: MQTTAsync.h:382
int MQTTAsync_isComplete(MQTTAsync handle, MQTTAsync_token token)
int cleanstart
Definition: MQTTAsync.h:1322
MQTTAsync_token token
Definition: MQTTAsync.h:596
int retained
Definition: MQTTAsync.h:304
Definition: MQTTAsync.h:537
const char * message
Definition: MQTTAsync.h:532
int struct_version
Definition: MQTTAsync.h:1059
Definition: MQTTProperties.h:112
const char * trustStore
Definition: MQTTAsync.h:1062
MQTTProperties properties
Definition: MQTTAsync.h:744
int automaticReconnect
Definition: MQTTAsync.h:1303
const char * privateKey
Definition: MQTTAsync.h:1072
int struct_version
Definition: MQTTAsync.h:594
int msgid
Definition: MQTTAsync.h:317
int code
Definition: MQTTAsync.h:550
char *const * serverURIs
Definition: MQTTAsync.h:1292
char struct_id[4]
Definition: MQTTAsync.h:701
int packet_type
Definition: MQTTAsync.h:554
MQTTProperties properties
Definition: MQTTAsync.h:1426
int MQTTAsync_setCallbacks(MQTTAsync handle, void *context, MQTTAsync_connectionLost *cl, MQTTAsync_messageArrived *ma, MQTTAsync_deliveryComplete *dc)
int MQTTAsync_sendMessage(MQTTAsync handle, const char *destinationName, const MQTTAsync_message *msg, MQTTAsync_responseOptions *response)
MQTTAsync_willOptions * will
Definition: MQTTAsync.h:1229
const char * CApath
Definition: MQTTAsync.h:1108
MQTTAsync_token token
Definition: MQTTAsync.h:528
int MQTTAsync_send(MQTTAsync handle, const char *destinationName, int payloadlen, const void *payload, int qos, int retained, MQTTAsync_responseOptions *response)
Definition: MQTTAsync.h:1047
void * MQTTAsync_malloc(size_t size)
int MQTTAsync_disconnect(MQTTAsync handle, const MQTTAsync_disconnectOptions *options)
@ MQTTASYNC_TRACE_SEVERE
Definition: MQTTAsync.h:1684
int MQTTAsync_subscribeMany(MQTTAsync handle, int count, char *const *topic, const int *qos, MQTTAsync_responseOptions *response)
MQTTProperties * willProperties
Definition: MQTTAsync.h:1330
MQTTAsync_onSuccess5 * onSuccess5
Definition: MQTTAsync.h:1336
int payloadlen
Definition: MQTTAsync.h:269
int sslVersion
Definition: MQTTAsync.h:1094
int MQTTVersion
Definition: MQTTAsync.h:618
const char * username
Definition: MQTTAsync.h:467
const char * keyStore
Definition: MQTTAsync.h:1067
void MQTTAsync_destroy(MQTTAsync *handle)
int MQTTAsync_unsubscribeMany(MQTTAsync handle, int count, char *const *topic, MQTTAsync_responseOptions *response)
int serverURIcount
Definition: MQTTAsync.h:1280
MQTTAsync_onFailure5 * onFailure5
Definition: MQTTAsync.h:1442
int len
Definition: MQTTAsync.h:474
MQTTAsync_message message
Definition: MQTTAsync.h:611
MQTTAsync_onFailure5 * onFailure5
Definition: MQTTAsync.h:1342
int connectTimeout
Definition: MQTTAsync.h:1245
MQTTAsync_token token
Definition: MQTTAsync.h:544
void MQTTAsync_setTraceLevel(enum MQTTASYNC_TRACE_LEVELS level)
const char * httpsProxy
Definition: MQTTAsync.h:1354
MQTTProperties * connectProperties
Definition: MQTTAsync.h:1326
int maxRetryInterval
Definition: MQTTAsync.h:1311
Definition: MQTTAsync.h:560
int MQTTAsync_setBeforePersistenceWrite(MQTTAsync handle, void *context, MQTTPersistence_beforeWrite *co)
int MQTTAsync_setConnectionLostCallback(MQTTAsync handle, void *context, MQTTAsync_connectionLost *cl)
MQTTAsync_onSuccess * onSuccess
Definition: MQTTAsync.h:1410
@ MQTTASYNC_TRACE_FATAL
Definition: MQTTAsync.h:1685
void MQTTAsync_onFailure(void *context, MQTTAsync_failureData *response)
Definition: MQTTAsync.h:676
MQTTAsync_onFailure5 * onFailure5
Definition: MQTTAsync.h:740
int MQTTAsync_setUpdateConnectOptions(MQTTAsync handle, void *context, MQTTAsync_updateConnectOptions *co)
void MQTTAsync_traceCallback(enum MQTTASYNC_TRACE_LEVELS level, char *message)
Definition: MQTTAsync.h:1705
int MQTTAsync_getPendingTokens(MQTTAsync handle, MQTTAsync_token **tokens)
int MQTTAsync_updateConnectOptions(void *context, MQTTAsync_connectData *data)
Definition: MQTTAsync.h:487
int retryInterval
Definition: MQTTAsync.h:1253
void * context
Definition: MQTTAsync.h:1422
MQTTAsync_message message
Definition: MQTTAsync.h:576
int minRetryInterval
Definition: MQTTAsync.h:1307
int struct_version
Definition: MQTTAsync.h:542
Definition: MQTTAsync.h:698
Definition: MQTTAsync.h:455
void * ssl_psk_context
Definition: MQTTAsync.h:1133
MQTTProperties properties
Definition: MQTTAsync.h:598
@ MQTTASYNC_TRACE_MAXIMUM
Definition: MQTTAsync.h:1679
int MQTTPersistence_beforeWrite(void *context, int bufcount, char *buffers[], int buflens[])
Definition: MQTTClientPersistence.h:264
int MQTTAsync_create(MQTTAsync *handle, const char *serverURI, const char *clientId, int persistence_type, void *persistence_context)
const char * topicName
Definition: MQTTAsync.h:1008
void MQTTAsync_connectionLost(void *context, char *cause)
Definition: MQTTAsync.h:402
void MQTTAsync_global_init(MQTTAsync_init_options *inits)
Definition: MQTTAsync.h:221
void MQTTAsync_onFailure5(void *context, MQTTAsync_failureData5 *response)
Definition: MQTTAsync.h:691
int keepAliveInterval
Definition: MQTTAsync.h:1197
char * destinationName
Definition: MQTTAsync.h:612
MQTTAsync_onSuccess5 * onSuccess5
Definition: MQTTAsync.h:1436
const char * enabledCipherSuites
Definition: MQTTAsync.h:1085
int qos
Definition: MQTTAsync.h:285
int struct_version
Definition: MQTTAsync.h:1399
int MQTTAsync_unsubscribe(MQTTAsync handle, const char *topic, MQTTAsync_responseOptions *response)
void MQTTAsync_disconnected(void *context, MQTTProperties *properties, enum MQTTReasonCodes reasonCode)
Definition: MQTTAsync.h:434
int MQTTAsync_messageArrived(void *context, char *topicName, int topicLen, MQTTAsync_message *message)
Definition: MQTTAsync.h:359
Definition: MQTTAsync.h:999
void * payload
Definition: MQTTAsync.h:271
@ MQTTASYNC_TRACE_MINIMUM
Definition: MQTTAsync.h:1681
MQTTAsync_token token
Definition: MQTTAsync.h:728
int MQTTAsync_reconnect(MQTTAsync handle)
const void * data
Definition: MQTTAsync.h:1317
const void * data
Definition: MQTTAsync.h:475
MQTTASYNC_TRACE_LEVELS
Definition: MQTTAsync.h:1677
int struct_version
Definition: MQTTAsync.h:1006
const char * name
Definition: MQTTAsync.h:1163
int MQTTAsync_setDeliveryCompleteCallback(MQTTAsync handle, void *context, MQTTAsync_deliveryComplete *dc)
char * destinationName
Definition: MQTTAsync.h:577
int MQTTAsync_connect(MQTTAsync handle, const MQTTAsync_connectOptions *options)
int sendWhileDisconnected
Definition: MQTTAsync.h:952
Definition: MQTTAsync.h:261
MQTTAsync_onFailure * onFailure
Definition: MQTTAsync.h:716
int MQTTVersion
Definition: MQTTAsync.h:1299
const unsigned char * protos
Definition: MQTTAsync.h:1149
int struct_version
Definition: MQTTAsync.h:460
const char * username
Definition: MQTTAsync.h:1235
void MQTTAsync_free(void *ptr)
Definition: MQTTAsync.h:1172
MQTTAsync_onSuccess5 * onSuccess5
Definition: MQTTAsync.h:734
MQTTProperties properties
Definition: MQTTAsync.h:548
@ MQTTASYNC_TRACE_PROTOCOL
Definition: MQTTAsync.h:1682
const char * MQTTAsync_strerror(int code)
int verify
Definition: MQTTAsync.h:1101
char * serverURI
Definition: MQTTAsync.h:617
Definition: MQTTAsync.h:1161
const char * privateKeyPassword
Definition: MQTTAsync.h:1075
Definition: MQTTAsync.h:525
Definition: MQTTSubscribeOpts.h:21
int disableDefaultTrustStore
Definition: MQTTAsync.h:1140
const void * data
Definition: MQTTAsync.h:1024
int maxInflight
Definition: MQTTAsync.h:1223
MQTTAsync_onSuccess * onSuccess
Definition: MQTTAsync.h:710
MQTTAsync_SSLOptions * ssl
Definition: MQTTAsync.h:1258
struct MQTTAsync_responseOptions MQTTAsync_responseOptions
int persistQoS0
Definition: MQTTAsync.h:976
int retained
Definition: MQTTAsync.h:1014
int maxBufferedMessages
Definition: MQTTAsync.h:954
int deleteOldestMessages
Definition: MQTTAsync.h:968
enum MQTTReasonCodes * reasonCodes
Definition: MQTTAsync.h:606
const char * password
Definition: MQTTAsync.h:1241
int code
Definition: MQTTAsync.h:530
MQTTSubscribe_options subscribeOptions
Definition: MQTTAsync.h:748
const char * message
Definition: MQTTAsync.h:1010
MQTTAsync_onFailure * onFailure
Definition: MQTTAsync.h:1416
const char * value
Definition: MQTTAsync.h:1164
int MQTTAsync_setConnected(MQTTAsync handle, void *context, MQTTAsync_connected *co)
const char * message
Definition: MQTTAsync.h:552
Definition: MQTTAsync.h:1394
MQTTSubscribe_options * subscribeOptionsList
Definition: MQTTAsync.h:757
int MQTTPersistence_afterRead(void *context, char **buffer, int *buflen)
Definition: MQTTClientPersistence.h:275
int subscribeOptionsCount
Definition: MQTTAsync.h:753
int len
Definition: MQTTAsync.h:1316
@ MQTTASYNC_TRACE_ERROR
Definition: MQTTAsync.h:1683
int struct_version
Definition: MQTTAsync.h:226
void MQTTAsync_connected(void *context, char *cause)
Definition: MQTTAsync.h:420
int enableServerCertAuth
Definition: MQTTAsync.h:1088
int MQTTAsync_setAfterPersistenceRead(MQTTAsync handle, void *context, MQTTPersistence_afterRead *co)
void MQTTAsync_onSuccess5(void *context, MQTTAsync_successData5 *response)
Definition: MQTTAsync.h:661
This structure represents a persistent data store, used to store outbound and inbound messages,...
int reasonCodeCount
Definition: MQTTAsync.h:605
int qos
Definition: MQTTAsync.h:569
int timeout
Definition: MQTTAsync.h:1404
int dup
Definition: MQTTAsync.h:311
MQTTProperties properties
Definition: MQTTAsync.h:321
int struct_version
Definition: MQTTAsync.h:267
int len
Definition: MQTTAsync.h:1023
void * ssl_error_context
Definition: MQTTAsync.h:1120
int struct_version
Definition: MQTTAsync.h:704
int qos
Definition: MQTTAsync.h:1019
MQTTAsync_token token
Definition: MQTTAsync.h:563
int cleansession
Definition: MQTTAsync.h:1219
int restoreMessages
Definition: MQTTAsync.h:972
@ MQTTASYNC_TRACE_MEDIUM
Definition: MQTTAsync.h:1680
void MQTTAsync_freeMessage(MQTTAsync_message **msg)
MQTTReasonCodes
Definition: MQTTReasonCodes.h:23
void * context
Definition: MQTTAsync.h:1276
void MQTTAsync_onSuccess(void *context, MQTTAsync_successData *response)
Definition: MQTTAsync.h:645
MQTTAsync_onFailure * onFailure
Definition: MQTTAsync.h:1270
Definition: MQTTAsync.h:941
MQTTAsync_onSuccess * onSuccess
Definition: MQTTAsync.h:1264