 |
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 MQTTASYNC_MAX_BUFFERED -19
204 #define MQTTVERSION_DEFAULT 0
208 #define MQTTVERSION_3_1 3
212 #define MQTTVERSION_3_1_1 4
216 #define MQTTVERSION_5 5
220 #define MQTT_BAD_SUBSCRIBE 0x80
236 #define MQTTAsync_init_options_initializer { {'M', 'Q', 'T', 'G'}, 0, 0 }
329 #define MQTTAsync_message_initializer { {'M', 'Q', 'T', 'M'}, 1, 0, NULL, 0, 0, 0, 0, MQTTProperties_initializer }
484 #define MQTTAsync_connectData_initializer {{'M', 'Q', 'C', 'D'}, 0, NULL, {0, NULL}}
562 #define MQTTAsync_failureData5_initializer {{'M', 'Q', 'F', 'D'}, 0, 0, MQTTREASONCODE_SUCCESS, MQTTProperties_initializer, 0, NULL, 0}
635 #define MQTTAsync_successData5_initializer {{'M', 'Q', 'S', 'D'}, 0, 0, MQTTREASONCODE_SUCCESS, MQTTProperties_initializer, {.sub={0,0}}}
765 #define MQTTAsync_responseOptions_initializer { {'M', 'Q', 'T', 'R'}, 1, NULL, NULL, 0, 0, NULL, NULL, MQTTProperties_initializer, MQTTSubscribe_options_initializer, 0, NULL}
769 #define MQTTAsync_callOptions_initializer MQTTAsync_responseOptions_initializer
943 int persistence_type,
void* persistence_context);
986 #define MQTTAsync_createOptions_initializer { {'M', 'Q', 'C', 'O'}, 2, 0, 100, MQTTVERSION_DEFAULT, 0, 0, 1, 1}
988 #define MQTTAsync_createOptions_initializer5 { {'M', 'Q', 'C', 'O'}, 2, 0, 100, MQTTVERSION_5, 0, 0, 1, 1}
1035 #define MQTTAsync_willOptions_initializer { {'M', 'Q', 'T', 'W'}, 1, NULL, NULL, 0, 0, { 0, NULL } }
1037 #define MQTT_SSL_VERSION_DEFAULT 0
1038 #define MQTT_SSL_VERSION_TLS_1_0 1
1039 #define MQTT_SSL_VERSION_TLS_1_1 2
1040 #define MQTT_SSL_VERSION_TLS_1_2 3
1121 int (*ssl_error_cb) (
const char *str,
size_t len,
void *u);
1134 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);
1165 #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 }
1365 #define MQTTAsync_connectOptions_initializer { {'M', 'Q', 'T', 'C'}, 8, 60, 1, 65535, NULL, NULL, NULL, 30, 0,\
1366 NULL, NULL, NULL, NULL, 0, NULL, MQTTVERSION_DEFAULT, 0, 1, 60, {0, NULL}, 0, NULL, NULL, NULL, NULL, NULL, NULL, NULL}
1368 #define MQTTAsync_connectOptions_initializer5 { {'M', 'Q', 'T', 'C'}, 8, 60, 0, 65535, NULL, NULL, NULL, 30, 0,\
1369 NULL, NULL, NULL, NULL, 0, NULL, MQTTVERSION_5, 0, 1, 60, {0, NULL}, 1, NULL, NULL, NULL, NULL, NULL, NULL, NULL}
1371 #define MQTTAsync_connectOptions_initializer_ws { {'M', 'Q', 'T', 'C'}, 8, 45, 1, 65535, NULL, NULL, NULL, 30, 0,\
1372 NULL, NULL, NULL, NULL, 0, NULL, MQTTVERSION_DEFAULT, 0, 1, 60, {0, NULL}, 0, NULL, NULL, NULL, NULL, NULL, NULL, NULL}
1374 #define MQTTAsync_connectOptions_initializer5_ws { {'M', 'Q', 'T', 'C'}, 8, 45, 0, 65535, NULL, NULL, NULL, 30, 0,\
1375 NULL, NULL, NULL, NULL, 0, NULL, MQTTVERSION_5, 0, 1, 60, {0, NULL}, 1, NULL, NULL, NULL, NULL, NULL, NULL, NULL}
1452 #define MQTTAsync_disconnectOptions_initializer { {'M', 'Q', 'T', 'D'}, 0, 0, NULL, NULL, NULL,\
1453 MQTTProperties_initializer, MQTTREASONCODE_SUCCESS, NULL, NULL }
1455 #define MQTTAsync_disconnectOptions_initializer5 { {'M', 'Q', 'T', 'D'}, 1, 0, NULL, NULL, NULL,\
1456 MQTTProperties_initializer, MQTTREASONCODE_SUCCESS, NULL, NULL }
1573 LIBMQTT_API
int MQTTAsync_send(
MQTTAsync handle,
const char* destinationName,
int payloadlen,
const void* payload,
int qos,
1623 #define MQTTASYNC_TRUE 1
2353 #if defined(__cplusplus)
int MQTTAsync_isConnected(MQTTAsync handle)
unsigned int protos_len
Definition: MQTTAsync.h:1162
int MQTTAsync_waitForCompletion(MQTTAsync handle, MQTTAsync_token token, unsigned long timeout)
int * qosList
Definition: MQTTAsync.h:577
const MQTTAsync_nameValue * httpHeaders
Definition: MQTTAsync.h:1353
void * context
Definition: MQTTAsync.h:727
int sessionPresent
Definition: MQTTAsync.h:624
int MQTTAsync_token
Definition: MQTTAsync.h:258
int MQTTVersion
Definition: MQTTAsync.h:588
int allowDisconnectedSendAtAnyTime
Definition: MQTTAsync.h:971
int MQTTVersion
Definition: MQTTAsync.h:967
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:955
MQTTAsync_nameValue * MQTTAsync_getVersionInfo(void)
int MQTTAsync_subscribe(MQTTAsync handle, const char *topic, int qos, MQTTAsync_responseOptions *response)
void * MQTTAsync
Definition: MQTTAsync.h:248
const char * httpProxy
Definition: MQTTAsync.h:1357
int struct_version
Definition: MQTTAsync.h:1193
char * serverURI
Definition: MQTTAsync.h:587
int sessionPresent
Definition: MQTTAsync.h:589
int do_openssl_init
Definition: MQTTAsync.h:233
void MQTTAsync_setTraceCallback(MQTTAsync_traceCallback *callback)
int MQTTAsync_setMessageArrivedCallback(MQTTAsync handle, void *context, MQTTAsync_messageArrived *ma)
Definition: MQTTAsync.h:596
void MQTTAsync_deliveryComplete(void *context, MQTTAsync_token token)
Definition: MQTTAsync.h:387
int MQTTAsync_isComplete(MQTTAsync handle, MQTTAsync_token token)
int cleanstart
Definition: MQTTAsync.h:1329
MQTTAsync_token token
Definition: MQTTAsync.h:601
int retained
Definition: MQTTAsync.h:309
Definition: MQTTAsync.h:542
const char * message
Definition: MQTTAsync.h:537
int struct_version
Definition: MQTTAsync.h:1066
Definition: MQTTProperties.h:112
const char * trustStore
Definition: MQTTAsync.h:1069
MQTTProperties properties
Definition: MQTTAsync.h:749
int automaticReconnect
Definition: MQTTAsync.h:1310
const char * privateKey
Definition: MQTTAsync.h:1079
int struct_version
Definition: MQTTAsync.h:599
int msgid
Definition: MQTTAsync.h:322
int code
Definition: MQTTAsync.h:555
char *const * serverURIs
Definition: MQTTAsync.h:1299
char struct_id[4]
Definition: MQTTAsync.h:706
int packet_type
Definition: MQTTAsync.h:559
MQTTProperties properties
Definition: MQTTAsync.h:1433
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:1236
const char * CApath
Definition: MQTTAsync.h:1115
MQTTAsync_token token
Definition: MQTTAsync.h:533
int MQTTAsync_send(MQTTAsync handle, const char *destinationName, int payloadlen, const void *payload, int qos, int retained, MQTTAsync_responseOptions *response)
Definition: MQTTAsync.h:1054
void * MQTTAsync_malloc(size_t size)
int MQTTAsync_disconnect(MQTTAsync handle, const MQTTAsync_disconnectOptions *options)
@ MQTTASYNC_TRACE_SEVERE
Definition: MQTTAsync.h:1691
int MQTTAsync_subscribeMany(MQTTAsync handle, int count, char *const *topic, const int *qos, MQTTAsync_responseOptions *response)
MQTTProperties * willProperties
Definition: MQTTAsync.h:1337
MQTTAsync_onSuccess5 * onSuccess5
Definition: MQTTAsync.h:1343
int payloadlen
Definition: MQTTAsync.h:274
int sslVersion
Definition: MQTTAsync.h:1101
int MQTTVersion
Definition: MQTTAsync.h:623
const char * username
Definition: MQTTAsync.h:472
const char * keyStore
Definition: MQTTAsync.h:1074
void MQTTAsync_destroy(MQTTAsync *handle)
int MQTTAsync_unsubscribeMany(MQTTAsync handle, int count, char *const *topic, MQTTAsync_responseOptions *response)
int serverURIcount
Definition: MQTTAsync.h:1287
MQTTAsync_onFailure5 * onFailure5
Definition: MQTTAsync.h:1449
int len
Definition: MQTTAsync.h:479
MQTTAsync_message message
Definition: MQTTAsync.h:616
MQTTAsync_onFailure5 * onFailure5
Definition: MQTTAsync.h:1349
int connectTimeout
Definition: MQTTAsync.h:1252
MQTTAsync_token token
Definition: MQTTAsync.h:549
void MQTTAsync_setTraceLevel(enum MQTTASYNC_TRACE_LEVELS level)
const char * httpsProxy
Definition: MQTTAsync.h:1361
MQTTProperties * connectProperties
Definition: MQTTAsync.h:1333
int maxRetryInterval
Definition: MQTTAsync.h:1318
Definition: MQTTAsync.h:565
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:1417
@ MQTTASYNC_TRACE_FATAL
Definition: MQTTAsync.h:1692
void MQTTAsync_onFailure(void *context, MQTTAsync_failureData *response)
Definition: MQTTAsync.h:681
MQTTAsync_onFailure5 * onFailure5
Definition: MQTTAsync.h:745
int MQTTAsync_setUpdateConnectOptions(MQTTAsync handle, void *context, MQTTAsync_updateConnectOptions *co)
void MQTTAsync_traceCallback(enum MQTTASYNC_TRACE_LEVELS level, char *message)
Definition: MQTTAsync.h:1713
int MQTTAsync_getPendingTokens(MQTTAsync handle, MQTTAsync_token **tokens)
int MQTTAsync_updateConnectOptions(void *context, MQTTAsync_connectData *data)
Definition: MQTTAsync.h:492
int retryInterval
Definition: MQTTAsync.h:1260
void * context
Definition: MQTTAsync.h:1429
MQTTAsync_message message
Definition: MQTTAsync.h:581
int minRetryInterval
Definition: MQTTAsync.h:1314
int struct_version
Definition: MQTTAsync.h:547
Definition: MQTTAsync.h:703
Definition: MQTTAsync.h:460
void * ssl_psk_context
Definition: MQTTAsync.h:1140
MQTTProperties properties
Definition: MQTTAsync.h:603
@ MQTTASYNC_TRACE_MAXIMUM
Definition: MQTTAsync.h:1686
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:1015
void MQTTAsync_connectionLost(void *context, char *cause)
Definition: MQTTAsync.h:407
void MQTTAsync_global_init(MQTTAsync_init_options *inits)
Definition: MQTTAsync.h:226
void MQTTAsync_onFailure5(void *context, MQTTAsync_failureData5 *response)
Definition: MQTTAsync.h:696
int keepAliveInterval
Definition: MQTTAsync.h:1204
char * destinationName
Definition: MQTTAsync.h:617
MQTTAsync_onSuccess5 * onSuccess5
Definition: MQTTAsync.h:1443
const char * enabledCipherSuites
Definition: MQTTAsync.h:1092
int qos
Definition: MQTTAsync.h:290
int struct_version
Definition: MQTTAsync.h:1406
int MQTTAsync_unsubscribe(MQTTAsync handle, const char *topic, MQTTAsync_responseOptions *response)
void MQTTAsync_disconnected(void *context, MQTTProperties *properties, enum MQTTReasonCodes reasonCode)
Definition: MQTTAsync.h:439
int MQTTAsync_messageArrived(void *context, char *topicName, int topicLen, MQTTAsync_message *message)
Definition: MQTTAsync.h:364
Definition: MQTTAsync.h:1006
void * payload
Definition: MQTTAsync.h:276
@ MQTTASYNC_TRACE_MINIMUM
Definition: MQTTAsync.h:1688
MQTTAsync_token token
Definition: MQTTAsync.h:733
int MQTTAsync_reconnect(MQTTAsync handle)
const void * data
Definition: MQTTAsync.h:1324
const void * data
Definition: MQTTAsync.h:480
MQTTASYNC_TRACE_LEVELS
Definition: MQTTAsync.h:1684
int struct_version
Definition: MQTTAsync.h:1013
const char * name
Definition: MQTTAsync.h:1170
int MQTTAsync_setDeliveryCompleteCallback(MQTTAsync handle, void *context, MQTTAsync_deliveryComplete *dc)
char * destinationName
Definition: MQTTAsync.h:582
int MQTTAsync_connect(MQTTAsync handle, const MQTTAsync_connectOptions *options)
int sendWhileDisconnected
Definition: MQTTAsync.h:957
Definition: MQTTAsync.h:266
MQTTAsync_onFailure * onFailure
Definition: MQTTAsync.h:721
int MQTTVersion
Definition: MQTTAsync.h:1306
const unsigned char * protos
Definition: MQTTAsync.h:1156
int struct_version
Definition: MQTTAsync.h:465
const char * username
Definition: MQTTAsync.h:1242
void MQTTAsync_free(void *ptr)
Definition: MQTTAsync.h:1179
MQTTAsync_onSuccess5 * onSuccess5
Definition: MQTTAsync.h:739
MQTTProperties properties
Definition: MQTTAsync.h:553
@ MQTTASYNC_TRACE_PROTOCOL
Definition: MQTTAsync.h:1689
const char * MQTTAsync_strerror(int code)
int verify
Definition: MQTTAsync.h:1108
char * serverURI
Definition: MQTTAsync.h:622
Definition: MQTTAsync.h:1168
const char * privateKeyPassword
Definition: MQTTAsync.h:1082
Definition: MQTTAsync.h:530
Definition: MQTTSubscribeOpts.h:21
int disableDefaultTrustStore
Definition: MQTTAsync.h:1147
const void * data
Definition: MQTTAsync.h:1031
int maxInflight
Definition: MQTTAsync.h:1230
MQTTAsync_onSuccess * onSuccess
Definition: MQTTAsync.h:715
MQTTAsync_SSLOptions * ssl
Definition: MQTTAsync.h:1265
struct MQTTAsync_responseOptions MQTTAsync_responseOptions
int persistQoS0
Definition: MQTTAsync.h:983
int retained
Definition: MQTTAsync.h:1021
int maxBufferedMessages
Definition: MQTTAsync.h:961
int deleteOldestMessages
Definition: MQTTAsync.h:975
enum MQTTReasonCodes * reasonCodes
Definition: MQTTAsync.h:611
const char * password
Definition: MQTTAsync.h:1248
int code
Definition: MQTTAsync.h:535
MQTTSubscribe_options subscribeOptions
Definition: MQTTAsync.h:753
const char * message
Definition: MQTTAsync.h:1017
MQTTAsync_onFailure * onFailure
Definition: MQTTAsync.h:1423
const char * value
Definition: MQTTAsync.h:1171
int MQTTAsync_setConnected(MQTTAsync handle, void *context, MQTTAsync_connected *co)
const char * message
Definition: MQTTAsync.h:557
Definition: MQTTAsync.h:1401
MQTTSubscribe_options * subscribeOptionsList
Definition: MQTTAsync.h:762
int MQTTPersistence_afterRead(void *context, char **buffer, int *buflen)
Definition: MQTTClientPersistence.h:275
int subscribeOptionsCount
Definition: MQTTAsync.h:758
int len
Definition: MQTTAsync.h:1323
@ MQTTASYNC_TRACE_ERROR
Definition: MQTTAsync.h:1690
int struct_version
Definition: MQTTAsync.h:231
void MQTTAsync_connected(void *context, char *cause)
Definition: MQTTAsync.h:425
int enableServerCertAuth
Definition: MQTTAsync.h:1095
int MQTTAsync_setAfterPersistenceRead(MQTTAsync handle, void *context, MQTTPersistence_afterRead *co)
void MQTTAsync_onSuccess5(void *context, MQTTAsync_successData5 *response)
Definition: MQTTAsync.h:666
This structure represents a persistent data store, used to store outbound and inbound messages,...
int reasonCodeCount
Definition: MQTTAsync.h:610
int qos
Definition: MQTTAsync.h:574
int timeout
Definition: MQTTAsync.h:1411
int dup
Definition: MQTTAsync.h:316
MQTTProperties properties
Definition: MQTTAsync.h:326
int struct_version
Definition: MQTTAsync.h:272
int len
Definition: MQTTAsync.h:1030
void * ssl_error_context
Definition: MQTTAsync.h:1127
int struct_version
Definition: MQTTAsync.h:709
int qos
Definition: MQTTAsync.h:1026
MQTTAsync_token token
Definition: MQTTAsync.h:568
int cleansession
Definition: MQTTAsync.h:1226
int restoreMessages
Definition: MQTTAsync.h:979
@ MQTTASYNC_TRACE_MEDIUM
Definition: MQTTAsync.h:1687
void MQTTAsync_freeMessage(MQTTAsync_message **msg)
MQTTReasonCodes
Definition: MQTTReasonCodes.h:23
void * context
Definition: MQTTAsync.h:1283
void MQTTAsync_onSuccess(void *context, MQTTAsync_successData *response)
Definition: MQTTAsync.h:650
MQTTAsync_onFailure * onFailure
Definition: MQTTAsync.h:1277
Definition: MQTTAsync.h:946
MQTTAsync_onSuccess * onSuccess
Definition: MQTTAsync.h:1271