 |
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 MQTTVERSION_DEFAULT 0
199 #define MQTTVERSION_3_1 3
203 #define MQTTVERSION_3_1_1 4
207 #define MQTTVERSION_5 5
211 #define MQTT_BAD_SUBSCRIBE 0x80
227 #define MQTTAsync_init_options_initializer { {'M', 'Q', 'T', 'G'}, 0, 0 }
320 #define MQTTAsync_message_initializer { {'M', 'Q', 'T', 'M'}, 1, 0, NULL, 0, 0, 0, 0, MQTTProperties_initializer }
475 #define MQTTAsync_connectData_initializer {{'M', 'Q', 'C', 'D'}, 0, NULL, {0, NULL}}
553 #define MQTTAsync_failureData5_initializer {{'M', 'Q', 'F', 'D'}, 0, 0, MQTTREASONCODE_SUCCESS, MQTTProperties_initializer, 0, NULL}
626 #define MQTTAsync_successData5_initializer {{'M', 'Q', 'S', 'D'}, 0, 0, MQTTREASONCODE_SUCCESS, MQTTProperties_initializer}
756 #define MQTTAsync_responseOptions_initializer { {'M', 'Q', 'T', 'R'}, 1, NULL, NULL, 0, 0, NULL, NULL, MQTTProperties_initializer, MQTTSubscribe_options_initializer, 0, NULL}
760 #define MQTTAsync_callOptions_initializer MQTTAsync_responseOptions_initializer
934 int persistence_type,
void* persistence_context);
975 #define MQTTAsync_createOptions_initializer { {'M', 'Q', 'C', 'O'}, 2, 0, 100, MQTTVERSION_DEFAULT, 0, 0, 1, 1}
977 #define MQTTAsync_createOptions_initializer5 { {'M', 'Q', 'C', 'O'}, 2, 0, 100, MQTTVERSION_5, 0, 0, 1, 1}
1024 #define MQTTAsync_willOptions_initializer { {'M', 'Q', 'T', 'W'}, 1, NULL, NULL, 0, 0, { 0, NULL } }
1026 #define MQTT_SSL_VERSION_DEFAULT 0
1027 #define MQTT_SSL_VERSION_TLS_1_0 1
1028 #define MQTT_SSL_VERSION_TLS_1_1 2
1029 #define MQTT_SSL_VERSION_TLS_1_2 3
1110 int (*ssl_error_cb) (
const char *str,
size_t len,
void *u);
1123 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);
1154 #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 }
1354 #define MQTTAsync_connectOptions_initializer { {'M', 'Q', 'T', 'C'}, 8, 60, 1, 65535, NULL, NULL, NULL, 30, 0,\
1355 NULL, NULL, NULL, NULL, 0, NULL, MQTTVERSION_DEFAULT, 0, 1, 60, {0, NULL}, 0, NULL, NULL, NULL, NULL, NULL, NULL, NULL}
1357 #define MQTTAsync_connectOptions_initializer5 { {'M', 'Q', 'T', 'C'}, 8, 60, 0, 65535, NULL, NULL, NULL, 30, 0,\
1358 NULL, NULL, NULL, NULL, 0, NULL, MQTTVERSION_5, 0, 1, 60, {0, NULL}, 1, NULL, NULL, NULL, NULL, NULL, NULL, NULL}
1360 #define MQTTAsync_connectOptions_initializer_ws { {'M', 'Q', 'T', 'C'}, 8, 45, 1, 65535, NULL, NULL, NULL, 30, 0,\
1361 NULL, NULL, NULL, NULL, 0, NULL, MQTTVERSION_DEFAULT, 0, 1, 60, {0, NULL}, 0, NULL, NULL, NULL, NULL, NULL, NULL, NULL}
1363 #define MQTTAsync_connectOptions_initializer5_ws { {'M', 'Q', 'T', 'C'}, 8, 45, 0, 65535, NULL, NULL, NULL, 30, 0,\
1364 NULL, NULL, NULL, NULL, 0, NULL, MQTTVERSION_5, 0, 1, 60, {0, NULL}, 1, NULL, NULL, NULL, NULL, NULL, NULL, NULL}
1441 #define MQTTAsync_disconnectOptions_initializer { {'M', 'Q', 'T', 'D'}, 0, 0, NULL, NULL, NULL,\
1442 MQTTProperties_initializer, MQTTREASONCODE_SUCCESS, NULL, NULL }
1444 #define MQTTAsync_disconnectOptions_initializer5 { {'M', 'Q', 'T', 'D'}, 1, 0, NULL, NULL, NULL,\
1445 MQTTProperties_initializer, MQTTREASONCODE_SUCCESS, NULL, NULL }
1562 LIBMQTT_API
int MQTTAsync_send(
MQTTAsync handle,
const char* destinationName,
int payloadlen,
const void* payload,
int qos,
1612 #define MQTTASYNC_TRUE 1
2341 #if defined(__cplusplus)
int MQTTAsync_isConnected(MQTTAsync handle)
unsigned int protos_len
Definition: MQTTAsync.h:1151
int MQTTAsync_waitForCompletion(MQTTAsync handle, MQTTAsync_token token, unsigned long timeout)
int * qosList
Definition: MQTTAsync.h:568
const MQTTAsync_nameValue * httpHeaders
Definition: MQTTAsync.h:1342
void * context
Definition: MQTTAsync.h:718
int sessionPresent
Definition: MQTTAsync.h:615
int MQTTAsync_token
Definition: MQTTAsync.h:249
int MQTTVersion
Definition: MQTTAsync.h:579
int allowDisconnectedSendAtAnyTime
Definition: MQTTAsync.h:960
int MQTTVersion
Definition: MQTTAsync.h:956
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:946
MQTTAsync_nameValue * MQTTAsync_getVersionInfo(void)
int MQTTAsync_subscribe(MQTTAsync handle, const char *topic, int qos, MQTTAsync_responseOptions *response)
void * MQTTAsync
Definition: MQTTAsync.h:239
const char * httpProxy
Definition: MQTTAsync.h:1346
int struct_version
Definition: MQTTAsync.h:1182
char * serverURI
Definition: MQTTAsync.h:578
int sessionPresent
Definition: MQTTAsync.h:580
int do_openssl_init
Definition: MQTTAsync.h:224
void MQTTAsync_setTraceCallback(MQTTAsync_traceCallback *callback)
int MQTTAsync_setMessageArrivedCallback(MQTTAsync handle, void *context, MQTTAsync_messageArrived *ma)
Definition: MQTTAsync.h:587
void MQTTAsync_deliveryComplete(void *context, MQTTAsync_token token)
Definition: MQTTAsync.h:378
int MQTTAsync_isComplete(MQTTAsync handle, MQTTAsync_token token)
int cleanstart
Definition: MQTTAsync.h:1318
MQTTAsync_token token
Definition: MQTTAsync.h:592
int retained
Definition: MQTTAsync.h:300
Definition: MQTTAsync.h:533
const char * message
Definition: MQTTAsync.h:528
int struct_version
Definition: MQTTAsync.h:1055
Definition: MQTTProperties.h:112
const char * trustStore
Definition: MQTTAsync.h:1058
MQTTProperties properties
Definition: MQTTAsync.h:740
int automaticReconnect
Definition: MQTTAsync.h:1299
const char * privateKey
Definition: MQTTAsync.h:1068
int struct_version
Definition: MQTTAsync.h:590
int msgid
Definition: MQTTAsync.h:313
int code
Definition: MQTTAsync.h:546
char *const * serverURIs
Definition: MQTTAsync.h:1288
char struct_id[4]
Definition: MQTTAsync.h:697
int packet_type
Definition: MQTTAsync.h:550
MQTTProperties properties
Definition: MQTTAsync.h:1422
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:1225
const char * CApath
Definition: MQTTAsync.h:1104
MQTTAsync_token token
Definition: MQTTAsync.h:524
int MQTTAsync_send(MQTTAsync handle, const char *destinationName, int payloadlen, const void *payload, int qos, int retained, MQTTAsync_responseOptions *response)
Definition: MQTTAsync.h:1043
void * MQTTAsync_malloc(size_t size)
int MQTTAsync_disconnect(MQTTAsync handle, const MQTTAsync_disconnectOptions *options)
@ MQTTASYNC_TRACE_SEVERE
Definition: MQTTAsync.h:1680
int MQTTAsync_subscribeMany(MQTTAsync handle, int count, char *const *topic, const int *qos, MQTTAsync_responseOptions *response)
MQTTProperties * willProperties
Definition: MQTTAsync.h:1326
MQTTAsync_onSuccess5 * onSuccess5
Definition: MQTTAsync.h:1332
int payloadlen
Definition: MQTTAsync.h:265
int sslVersion
Definition: MQTTAsync.h:1090
int MQTTVersion
Definition: MQTTAsync.h:614
const char * username
Definition: MQTTAsync.h:463
const char * keyStore
Definition: MQTTAsync.h:1063
void MQTTAsync_destroy(MQTTAsync *handle)
int MQTTAsync_unsubscribeMany(MQTTAsync handle, int count, char *const *topic, MQTTAsync_responseOptions *response)
int serverURIcount
Definition: MQTTAsync.h:1276
MQTTAsync_onFailure5 * onFailure5
Definition: MQTTAsync.h:1438
int len
Definition: MQTTAsync.h:470
MQTTAsync_message message
Definition: MQTTAsync.h:607
MQTTAsync_onFailure5 * onFailure5
Definition: MQTTAsync.h:1338
int connectTimeout
Definition: MQTTAsync.h:1241
MQTTAsync_token token
Definition: MQTTAsync.h:540
void MQTTAsync_setTraceLevel(enum MQTTASYNC_TRACE_LEVELS level)
const char * httpsProxy
Definition: MQTTAsync.h:1350
MQTTProperties * connectProperties
Definition: MQTTAsync.h:1322
int maxRetryInterval
Definition: MQTTAsync.h:1307
Definition: MQTTAsync.h:556
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:1406
@ MQTTASYNC_TRACE_FATAL
Definition: MQTTAsync.h:1681
void MQTTAsync_onFailure(void *context, MQTTAsync_failureData *response)
Definition: MQTTAsync.h:672
MQTTAsync_onFailure5 * onFailure5
Definition: MQTTAsync.h:736
int MQTTAsync_setUpdateConnectOptions(MQTTAsync handle, void *context, MQTTAsync_updateConnectOptions *co)
void MQTTAsync_traceCallback(enum MQTTASYNC_TRACE_LEVELS level, char *message)
Definition: MQTTAsync.h:1701
int MQTTAsync_getPendingTokens(MQTTAsync handle, MQTTAsync_token **tokens)
int MQTTAsync_updateConnectOptions(void *context, MQTTAsync_connectData *data)
Definition: MQTTAsync.h:483
int retryInterval
Definition: MQTTAsync.h:1249
void * context
Definition: MQTTAsync.h:1418
MQTTAsync_message message
Definition: MQTTAsync.h:572
int minRetryInterval
Definition: MQTTAsync.h:1303
int struct_version
Definition: MQTTAsync.h:538
Definition: MQTTAsync.h:694
Definition: MQTTAsync.h:451
void * ssl_psk_context
Definition: MQTTAsync.h:1129
MQTTProperties properties
Definition: MQTTAsync.h:594
@ MQTTASYNC_TRACE_MAXIMUM
Definition: MQTTAsync.h:1675
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:1004
void MQTTAsync_connectionLost(void *context, char *cause)
Definition: MQTTAsync.h:398
void MQTTAsync_global_init(MQTTAsync_init_options *inits)
Definition: MQTTAsync.h:217
void MQTTAsync_onFailure5(void *context, MQTTAsync_failureData5 *response)
Definition: MQTTAsync.h:687
int keepAliveInterval
Definition: MQTTAsync.h:1193
char * destinationName
Definition: MQTTAsync.h:608
MQTTAsync_onSuccess5 * onSuccess5
Definition: MQTTAsync.h:1432
const char * enabledCipherSuites
Definition: MQTTAsync.h:1081
int qos
Definition: MQTTAsync.h:281
int struct_version
Definition: MQTTAsync.h:1395
int MQTTAsync_unsubscribe(MQTTAsync handle, const char *topic, MQTTAsync_responseOptions *response)
void MQTTAsync_disconnected(void *context, MQTTProperties *properties, enum MQTTReasonCodes reasonCode)
Definition: MQTTAsync.h:430
int MQTTAsync_messageArrived(void *context, char *topicName, int topicLen, MQTTAsync_message *message)
Definition: MQTTAsync.h:355
Definition: MQTTAsync.h:995
void * payload
Definition: MQTTAsync.h:267
@ MQTTASYNC_TRACE_MINIMUM
Definition: MQTTAsync.h:1677
MQTTAsync_token token
Definition: MQTTAsync.h:724
int MQTTAsync_reconnect(MQTTAsync handle)
const void * data
Definition: MQTTAsync.h:1313
const void * data
Definition: MQTTAsync.h:471
MQTTASYNC_TRACE_LEVELS
Definition: MQTTAsync.h:1673
int struct_version
Definition: MQTTAsync.h:1002
const char * name
Definition: MQTTAsync.h:1159
int MQTTAsync_setDeliveryCompleteCallback(MQTTAsync handle, void *context, MQTTAsync_deliveryComplete *dc)
char * destinationName
Definition: MQTTAsync.h:573
int MQTTAsync_connect(MQTTAsync handle, const MQTTAsync_connectOptions *options)
int sendWhileDisconnected
Definition: MQTTAsync.h:948
Definition: MQTTAsync.h:257
MQTTAsync_onFailure * onFailure
Definition: MQTTAsync.h:712
int MQTTVersion
Definition: MQTTAsync.h:1295
const unsigned char * protos
Definition: MQTTAsync.h:1145
int struct_version
Definition: MQTTAsync.h:456
const char * username
Definition: MQTTAsync.h:1231
void MQTTAsync_free(void *ptr)
Definition: MQTTAsync.h:1168
MQTTAsync_onSuccess5 * onSuccess5
Definition: MQTTAsync.h:730
MQTTProperties properties
Definition: MQTTAsync.h:544
@ MQTTASYNC_TRACE_PROTOCOL
Definition: MQTTAsync.h:1678
const char * MQTTAsync_strerror(int code)
int verify
Definition: MQTTAsync.h:1097
char * serverURI
Definition: MQTTAsync.h:613
Definition: MQTTAsync.h:1157
const char * privateKeyPassword
Definition: MQTTAsync.h:1071
Definition: MQTTAsync.h:521
Definition: MQTTSubscribeOpts.h:21
int disableDefaultTrustStore
Definition: MQTTAsync.h:1136
const void * data
Definition: MQTTAsync.h:1020
int maxInflight
Definition: MQTTAsync.h:1219
MQTTAsync_onSuccess * onSuccess
Definition: MQTTAsync.h:706
MQTTAsync_SSLOptions * ssl
Definition: MQTTAsync.h:1254
struct MQTTAsync_responseOptions MQTTAsync_responseOptions
int persistQoS0
Definition: MQTTAsync.h:972
int retained
Definition: MQTTAsync.h:1010
int maxBufferedMessages
Definition: MQTTAsync.h:950
int deleteOldestMessages
Definition: MQTTAsync.h:964
enum MQTTReasonCodes * reasonCodes
Definition: MQTTAsync.h:602
const char * password
Definition: MQTTAsync.h:1237
int code
Definition: MQTTAsync.h:526
MQTTSubscribe_options subscribeOptions
Definition: MQTTAsync.h:744
const char * message
Definition: MQTTAsync.h:1006
MQTTAsync_onFailure * onFailure
Definition: MQTTAsync.h:1412
const char * value
Definition: MQTTAsync.h:1160
int MQTTAsync_setConnected(MQTTAsync handle, void *context, MQTTAsync_connected *co)
const char * message
Definition: MQTTAsync.h:548
Definition: MQTTAsync.h:1390
MQTTSubscribe_options * subscribeOptionsList
Definition: MQTTAsync.h:753
int MQTTPersistence_afterRead(void *context, char **buffer, int *buflen)
Definition: MQTTClientPersistence.h:275
int subscribeOptionsCount
Definition: MQTTAsync.h:749
int len
Definition: MQTTAsync.h:1312
@ MQTTASYNC_TRACE_ERROR
Definition: MQTTAsync.h:1679
int struct_version
Definition: MQTTAsync.h:222
void MQTTAsync_connected(void *context, char *cause)
Definition: MQTTAsync.h:416
int enableServerCertAuth
Definition: MQTTAsync.h:1084
int MQTTAsync_setAfterPersistenceRead(MQTTAsync handle, void *context, MQTTPersistence_afterRead *co)
void MQTTAsync_onSuccess5(void *context, MQTTAsync_successData5 *response)
Definition: MQTTAsync.h:657
This structure represents a persistent data store, used to store outbound and inbound messages,...
int reasonCodeCount
Definition: MQTTAsync.h:601
int qos
Definition: MQTTAsync.h:565
int timeout
Definition: MQTTAsync.h:1400
int dup
Definition: MQTTAsync.h:307
MQTTProperties properties
Definition: MQTTAsync.h:317
int struct_version
Definition: MQTTAsync.h:263
int len
Definition: MQTTAsync.h:1019
void * ssl_error_context
Definition: MQTTAsync.h:1116
int struct_version
Definition: MQTTAsync.h:700
int qos
Definition: MQTTAsync.h:1015
MQTTAsync_token token
Definition: MQTTAsync.h:559
int cleansession
Definition: MQTTAsync.h:1215
int restoreMessages
Definition: MQTTAsync.h:968
@ MQTTASYNC_TRACE_MEDIUM
Definition: MQTTAsync.h:1676
void MQTTAsync_freeMessage(MQTTAsync_message **msg)
MQTTReasonCodes
Definition: MQTTReasonCodes.h:23
void * context
Definition: MQTTAsync.h:1272
void MQTTAsync_onSuccess(void *context, MQTTAsync_successData *response)
Definition: MQTTAsync.h:641
MQTTAsync_onFailure * onFailure
Definition: MQTTAsync.h:1266
Definition: MQTTAsync.h:937
MQTTAsync_onSuccess * onSuccess
Definition: MQTTAsync.h:1260