 |
Paho Asynchronous MQTT C Client Library
|
Go to the documentation of this file.
88 #if !defined(MQTTASYNC_H)
91 #if defined(__cplusplus)
95 #if defined(WIN32) || defined(WIN64)
96 #define DLLImport __declspec(dllimport)
97 #define DLLExport __declspec(dllexport)
99 #define DLLImport extern
100 #define DLLExport __attribute__ ((visibility ("default")))
111 #if !defined(NO_PERSISTENCE)
119 #define MQTTASYNC_SUCCESS 0
124 #define MQTTASYNC_FAILURE -1
128 #define MQTTASYNC_PERSISTENCE_ERROR -2
133 #define MQTTASYNC_DISCONNECTED -3
138 #define MQTTASYNC_MAX_MESSAGES_INFLIGHT -4
142 #define MQTTASYNC_BAD_UTF8_STRING -5
146 #define MQTTASYNC_NULL_PARAMETER -6
152 #define MQTTASYNC_TOPICNAME_TRUNCATED -7
157 #define MQTTASYNC_BAD_STRUCTURE -8
161 #define MQTTASYNC_BAD_QOS -9
165 #define MQTTASYNC_NO_MORE_MSGIDS -10
169 #define MQTTASYNC_OPERATION_INCOMPLETE -11
173 #define MQTTASYNC_MAX_BUFFERED_MESSAGES -12
177 #define MQTTASYNC_SSL_NOT_SUPPORTED -13
181 #define MQTTASYNC_BAD_PROTOCOL -14
185 #define MQTTASYNC_BAD_MQTT_OPTION -15
189 #define MQTTASYNC_WRONG_MQTT_VERSION -16
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 }
318 #define MQTTAsync_message_initializer { {'M', 'Q', 'T', 'M'}, 1, 0, NULL, 0, 0, 0, 0, MQTTProperties_initializer }
460 #define MQTTAsync_failureData5_initializer {{'M', 'Q', 'F', 'D'}, 0, 0, MQTTREASONCODE_SUCCESS, MQTTProperties_initializer, 0, NULL}
531 #define MQTTAsync_successData5_initializer {{'M', 'Q', 'S', 'D'}, 0, 0, MQTTREASONCODE_SUCCESS, MQTTProperties_initializer}
644 #define MQTTAsync_responseOptions_initializer { {'M', 'Q', 'T', 'R'}, 1, NULL, NULL, 0, 0, NULL, NULL, MQTTProperties_initializer, MQTTSubscribe_options_initializer, 0, NULL}
647 #define MQTTAsync_callOptions_initializer MQTTAsync_responseOptions_initializer
817 int persistence_type,
void* persistence_context);
839 #define MQTTAsync_createOptions_initializer { {'M', 'Q', 'C', 'O'}, 0, 0, 100, MQTTVERSION_DEFAULT }
886 #define MQTTAsync_willOptions_initializer { {'M', 'Q', 'T', 'W'}, 1, NULL, NULL, 0, 0, { 0, NULL } }
888 #define MQTT_SSL_VERSION_DEFAULT 0
889 #define MQTT_SSL_VERSION_TLS_1_0 1
890 #define MQTT_SSL_VERSION_TLS_1_1 2
891 #define MQTT_SSL_VERSION_TLS_1_2 3
964 int (*ssl_error_cb) (
const char *str,
size_t len,
void *u);
973 #define MQTTAsync_SSLOptions_initializer { {'M', 'Q', 'T', 'S'}, 3, NULL, NULL, NULL, NULL, NULL, 1, MQTT_SSL_VERSION_DEFAULT, 0, NULL, NULL, NULL }
1149 #define MQTTAsync_connectOptions_initializer { {'M', 'Q', 'T', 'C'}, 6, 60, 1, 65535, NULL, NULL, NULL, 30, 0,\
1150 NULL, NULL, NULL, NULL, 0, NULL, MQTTVERSION_DEFAULT, 0, 1, 60, {0, NULL}, 0, NULL, NULL, NULL, NULL}
1152 #define MQTTAsync_connectOptions_initializer5 { {'M', 'Q', 'T', 'C'}, 6, 60, 0, 65535, NULL, NULL, NULL, 30, 0,\
1153 NULL, NULL, NULL, NULL, 0, NULL, MQTTVERSION_5, 0, 1, 60, {0, NULL}, 1, NULL, NULL, NULL, NULL}
1230 #define MQTTAsync_disconnectOptions_initializer { {'M', 'Q', 'T', 'D'}, 1, 0, NULL, NULL, NULL, MQTTProperties_initializer, MQTTREASONCODE_SUCCESS }
1397 #define MQTTASYNC_TRUE 1
int MQTTAsync_isConnected(MQTTAsync handle)
int MQTTAsync_waitForCompletion(MQTTAsync handle, MQTTAsync_token token, unsigned long timeout)
int * qosList
Definition: MQTTAsync.h:473
void * context
Definition: MQTTAsync.h:606
int sessionPresent
Definition: MQTTAsync.h:520
int MQTTAsync_token
Definition: MQTTAsync.h:249
int MQTTVersion
Definition: MQTTAsync.h:484
int MQTTVersion
Definition: MQTTAsync.h:836
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:826
MQTTAsync_nameValue * MQTTAsync_getVersionInfo(void)
int MQTTAsync_subscribe(MQTTAsync handle, const char *topic, int qos, MQTTAsync_responseOptions *response)
void * MQTTAsync
Definition: MQTTAsync.h:239
int struct_version
Definition: MQTTAsync.h:992
char * serverURI
Definition: MQTTAsync.h:483
int sessionPresent
Definition: MQTTAsync.h:485
int do_openssl_init
Definition: MQTTAsync.h:224
void MQTTAsync_setTraceCallback(MQTTAsync_traceCallback *callback)
int MQTTAsync_setMessageArrivedCallback(MQTTAsync handle, void *context, MQTTAsync_messageArrived *ma)
int MQTTAsync_subscribeMany(MQTTAsync handle, int count, char *const *topic, int *qos, MQTTAsync_responseOptions *response)
Definition: MQTTAsync.h:492
void MQTTAsync_deliveryComplete(void *context, MQTTAsync_token token)
Definition: MQTTAsync.h:366
int MQTTAsync_isComplete(MQTTAsync handle, MQTTAsync_token token)
int cleanstart
Definition: MQTTAsync.h:1125
MQTTAsync_token token
Definition: MQTTAsync.h:497
int retained
Definition: MQTTAsync.h:300
Definition: MQTTAsync.h:440
const char * message
Definition: MQTTAsync.h:435
int struct_version
Definition: MQTTAsync.h:910
Definition: MQTTProperties.h:118
const char * trustStore
Definition: MQTTAsync.h:913
MQTTProperties properties
Definition: MQTTAsync.h:628
int automaticReconnect
Definition: MQTTAsync.h:1106
const char * privateKey
Definition: MQTTAsync.h:923
int struct_version
Definition: MQTTAsync.h:495
int msgid
Definition: MQTTAsync.h:311
int code
Definition: MQTTAsync.h:453
char *const * serverURIs
Definition: MQTTAsync.h:1095
char struct_id[4]
Definition: MQTTAsync.h:585
int packet_type
Definition: MQTTAsync.h:457
MQTTProperties properties
Definition: MQTTAsync.h:1211
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:1035
const char * CApath
Definition: MQTTAsync.h:958
MQTTAsync_token token
Definition: MQTTAsync.h:431
int MQTTAsync_send(MQTTAsync handle, const char *destinationName, int payloadlen, const void *payload, int qos, int retained, MQTTAsync_responseOptions *response)
Definition: MQTTAsync.h:905
int MQTTAsync_disconnect(MQTTAsync handle, const MQTTAsync_disconnectOptions *options)
@ MQTTASYNC_TRACE_SEVERE
Definition: MQTTAsync.h:1454
MQTTProperties * willProperties
Definition: MQTTAsync.h:1133
MQTTAsync_onSuccess5 * onSuccess5
Definition: MQTTAsync.h:1139
int payloadlen
Definition: MQTTAsync.h:265
int sslVersion
Definition: MQTTAsync.h:944
int MQTTVersion
Definition: MQTTAsync.h:519
const char * keyStore
Definition: MQTTAsync.h:918
void MQTTAsync_destroy(MQTTAsync *handle)
int MQTTAsync_unsubscribeMany(MQTTAsync handle, int count, char *const *topic, MQTTAsync_responseOptions *response)
int serverURIcount
Definition: MQTTAsync.h:1086
MQTTAsync_onFailure5 * onFailure5
Definition: MQTTAsync.h:1227
MQTTAsync_message message
Definition: MQTTAsync.h:512
MQTTAsync_onFailure5 * onFailure5
Definition: MQTTAsync.h:1145
int connectTimeout
Definition: MQTTAsync.h:1051
MQTTAsync_token token
Definition: MQTTAsync.h:447
void MQTTAsync_setTraceLevel(enum MQTTASYNC_TRACE_LEVELS level)
MQTTProperties * connectProperties
Definition: MQTTAsync.h:1129
int maxRetryInterval
Definition: MQTTAsync.h:1114
Definition: MQTTAsync.h:463
int MQTTAsync_setConnectionLostCallback(MQTTAsync handle, void *context, MQTTAsync_connectionLost *cl)
MQTTAsync_onSuccess * onSuccess
Definition: MQTTAsync.h:1195
@ MQTTASYNC_TRACE_FATAL
Definition: MQTTAsync.h:1455
void MQTTAsync_onFailure(void *context, MQTTAsync_failureData *response)
Definition: MQTTAsync.h:568
MQTTAsync_onFailure5 * onFailure5
Definition: MQTTAsync.h:624
void MQTTAsync_traceCallback(enum MQTTASYNC_TRACE_LEVELS level, char *message)
Definition: MQTTAsync.h:1475
int MQTTAsync_getPendingTokens(MQTTAsync handle, MQTTAsync_token **tokens)
int retryInterval
Definition: MQTTAsync.h:1059
void * context
Definition: MQTTAsync.h:1207
MQTTAsync_message message
Definition: MQTTAsync.h:477
int minRetryInterval
Definition: MQTTAsync.h:1110
int struct_version
Definition: MQTTAsync.h:445
Definition: MQTTAsync.h:582
MQTTProperties properties
Definition: MQTTAsync.h:499
@ MQTTASYNC_TRACE_MAXIMUM
Definition: MQTTAsync.h:1449
int MQTTAsync_create(MQTTAsync *handle, const char *serverURI, const char *clientId, int persistence_type, void *persistence_context)
const char * topicName
Definition: MQTTAsync.h:866
void MQTTAsync_connectionLost(void *context, char *cause)
Definition: MQTTAsync.h:383
void MQTTAsync_global_init(MQTTAsync_init_options *inits)
Definition: MQTTAsync.h:217
void MQTTAsync_onFailure5(void *context, MQTTAsync_failureData5 *response)
Definition: MQTTAsync.h:580
int keepAliveInterval
Definition: MQTTAsync.h:1003
char * destinationName
Definition: MQTTAsync.h:513
MQTTAsync_onSuccess5 * onSuccess5
Definition: MQTTAsync.h:1221
const char * enabledCipherSuites
Definition: MQTTAsync.h:935
int qos
Definition: MQTTAsync.h:281
int struct_version
Definition: MQTTAsync.h:1184
int MQTTAsync_unsubscribe(MQTTAsync handle, const char *topic, MQTTAsync_responseOptions *response)
void MQTTAsync_disconnected(void *context, MQTTProperties *properties, enum MQTTReasonCodes reasonCode)
Definition: MQTTAsync.h:409
int MQTTAsync_messageArrived(void *context, char *topicName, int topicLen, MQTTAsync_message *message)
Definition: MQTTAsync.h:346
Definition: MQTTAsync.h:857
void * payload
Definition: MQTTAsync.h:267
@ MQTTASYNC_TRACE_MINIMUM
Definition: MQTTAsync.h:1451
MQTTAsync_token token
Definition: MQTTAsync.h:612
int MQTTAsync_reconnect(MQTTAsync handle)
const void * data
Definition: MQTTAsync.h:1120
MQTTASYNC_TRACE_LEVELS
Definition: MQTTAsync.h:1447
int struct_version
Definition: MQTTAsync.h:864
const char * name
Definition: MQTTAsync.h:1488
int MQTTAsync_setDeliveryCompleteCallback(MQTTAsync handle, void *context, MQTTAsync_deliveryComplete *dc)
char * destinationName
Definition: MQTTAsync.h:478
int MQTTAsync_connect(MQTTAsync handle, const MQTTAsync_connectOptions *options)
int sendWhileDisconnected
Definition: MQTTAsync.h:828
Definition: MQTTAsync.h:257
MQTTAsync_onFailure * onFailure
Definition: MQTTAsync.h:600
int MQTTVersion
Definition: MQTTAsync.h:1102
const char * username
Definition: MQTTAsync.h:1041
void MQTTAsync_free(void *ptr)
Definition: MQTTAsync.h:980
MQTTAsync_onSuccess5 * onSuccess5
Definition: MQTTAsync.h:618
MQTTProperties properties
Definition: MQTTAsync.h:451
@ MQTTASYNC_TRACE_PROTOCOL
Definition: MQTTAsync.h:1452
const char * MQTTAsync_strerror(int code)
int verify
Definition: MQTTAsync.h:951
char * serverURI
Definition: MQTTAsync.h:518
Definition: MQTTAsync.h:1486
const char * privateKeyPassword
Definition: MQTTAsync.h:925
Definition: MQTTAsync.h:428
Definition: MQTTSubscribeOpts.h:21
const void * data
Definition: MQTTAsync.h:882
int maxInflight
Definition: MQTTAsync.h:1029
MQTTAsync_onSuccess * onSuccess
Definition: MQTTAsync.h:594
MQTTAsync_SSLOptions * ssl
Definition: MQTTAsync.h:1064
struct MQTTAsync_responseOptions MQTTAsync_responseOptions
int retained
Definition: MQTTAsync.h:872
int maxBufferedMessages
Definition: MQTTAsync.h:830
enum MQTTReasonCodes * reasonCodes
Definition: MQTTAsync.h:507
const char * password
Definition: MQTTAsync.h:1047
int code
Definition: MQTTAsync.h:433
MQTTSubscribe_options subscribeOptions
Definition: MQTTAsync.h:632
const char * message
Definition: MQTTAsync.h:868
MQTTAsync_onFailure * onFailure
Definition: MQTTAsync.h:1201
const char * value
Definition: MQTTAsync.h:1489
int MQTTAsync_setConnected(MQTTAsync handle, void *context, MQTTAsync_connected *co)
const char * message
Definition: MQTTAsync.h:455
Definition: MQTTAsync.h:1179
MQTTSubscribe_options * subscribeOptionsList
Definition: MQTTAsync.h:641
#define DLLExport
Definition: MQTTProperties.h:58
int subscribeOptionsCount
Definition: MQTTAsync.h:637
int len
Definition: MQTTAsync.h:1119
@ MQTTASYNC_TRACE_ERROR
Definition: MQTTAsync.h:1453
int struct_version
Definition: MQTTAsync.h:222
void MQTTAsync_connected(void *context, char *cause)
Definition: MQTTAsync.h:398
int enableServerCertAuth
Definition: MQTTAsync.h:938
void MQTTAsync_onSuccess5(void *context, MQTTAsync_successData5 *response)
Definition: MQTTAsync.h:556
This structure represents a persistent data store, used to store outbound and inbound messages,...
int reasonCodeCount
Definition: MQTTAsync.h:506
int qos
Definition: MQTTAsync.h:471
int timeout
Definition: MQTTAsync.h:1189
int dup
Definition: MQTTAsync.h:307
MQTTProperties properties
Definition: MQTTAsync.h:315
int struct_version
Definition: MQTTAsync.h:263
int len
Definition: MQTTAsync.h:881
void * ssl_error_context
Definition: MQTTAsync.h:970
int struct_version
Definition: MQTTAsync.h:588
int qos
Definition: MQTTAsync.h:877
MQTTAsync_token token
Definition: MQTTAsync.h:466
int cleansession
Definition: MQTTAsync.h:1025
@ MQTTASYNC_TRACE_MEDIUM
Definition: MQTTAsync.h:1450
void MQTTAsync_freeMessage(MQTTAsync_message **msg)
MQTTReasonCodes
Definition: MQTTReasonCodes.h:21
void * context
Definition: MQTTAsync.h:1082
void MQTTAsync_onSuccess(void *context, MQTTAsync_successData *response)
Definition: MQTTAsync.h:543
MQTTAsync_onFailure * onFailure
Definition: MQTTAsync.h:1076
Definition: MQTTAsync.h:819
MQTTAsync_onSuccess * onSuccess
Definition: MQTTAsync.h:1070