Paho MQTT C Client Library
MQTTClient.h
Go to the documentation of this file.
1/*******************************************************************************
2 * Copyright (c) 2009, 2020 IBM Corp. and others
3 *
4 * All rights reserved. This program and the accompanying materials
5 * are made available under the terms of the Eclipse Public License v2.0
6 * and Eclipse Distribution License v1.0 which accompany this distribution.
7 *
8 * The Eclipse Public License is available at
9 * https://www.eclipse.org/legal/epl-2.0/
10 * and the Eclipse Distribution License is available at
11 * http://www.eclipse.org/org/documents/edl-v10.php.
12 *
13 * Contributors:
14 * Ian Craggs - initial API and implementation and/or initial documentation
15 * Ian Craggs, Allan Stockdill-Mander - SSL updates
16 * Ian Craggs - multiple server connection support
17 * Ian Craggs - MQTT 3.1.1 support
18 * Ian Craggs - remove const from eyecatchers #168
19 *******************************************************************************/
20
103/*
105*/
106#if !defined(MQTTCLIENT_H)
107#define MQTTCLIENT_H
108
109#if defined(__cplusplus)
110 extern "C" {
111#endif
112
113#include <stdio.h>
114/*
116*/
117
118#include "MQTTExportDeclarations.h"
119
120#include "MQTTProperties.h"
121#include "MQTTReasonCodes.h"
122#include "MQTTSubscribeOpts.h"
123#if !defined(NO_PERSISTENCE)
125#endif
126
131#define MQTTCLIENT_SUCCESS 0
136#define MQTTCLIENT_FAILURE -1
137
138/* error code -2 is MQTTCLIENT_PERSISTENCE_ERROR */
139
143#define MQTTCLIENT_DISCONNECTED -3
148#define MQTTCLIENT_MAX_MESSAGES_INFLIGHT -4
152#define MQTTCLIENT_BAD_UTF8_STRING -5
156#define MQTTCLIENT_NULL_PARAMETER -6
162#define MQTTCLIENT_TOPICNAME_TRUNCATED -7
167#define MQTTCLIENT_BAD_STRUCTURE -8
171#define MQTTCLIENT_BAD_QOS -9
175#define MQTTCLIENT_SSL_NOT_SUPPORTED -10
179 #define MQTTCLIENT_BAD_MQTT_VERSION -11
185#define MQTTCLIENT_BAD_PROTOCOL -14
189 #define MQTTCLIENT_BAD_MQTT_OPTION -15
193 #define MQTTCLIENT_WRONG_MQTT_VERSION -16
197 #define MQTTCLIENT_0_LEN_WILL_TOPIC -17
198
199
203#define MQTTVERSION_DEFAULT 0
207#define MQTTVERSION_3_1 3
211#define MQTTVERSION_3_1_1 4
215 #define MQTTVERSION_5 5
219#define MQTT_BAD_SUBSCRIBE 0x80
220
224typedef struct
225{
227 char struct_id[4];
233
234#define MQTTClient_init_options_initializer { {'M', 'Q', 'T', 'G'}, 0, 0 }
235
241
246typedef void* MQTTClient;
259
266typedef struct
267{
269 char struct_id[4];
276 void* payload;
290 int qos;
316 int dup;
320 int msgid;
326
327#define MQTTClient_message_initializer { {'M', 'Q', 'T', 'M'}, 1, 0, NULL, 0, 0, 0, 0, MQTTProperties_initializer }
328
359typedef int MQTTClient_messageArrived(void* context, char* topicName, int topicLen, MQTTClient_message* message);
360
382
398typedef void MQTTClient_connectionLost(void* context, char* cause);
399
427LIBMQTT_API int MQTTClient_setCallbacks(MQTTClient handle, void* context, MQTTClient_connectionLost* cl,
429
430
440typedef void MQTTClient_disconnected(void* context, MQTTProperties* properties,
441 enum MQTTReasonCodes reasonCode);
442
456LIBMQTT_API int MQTTClient_setDisconnected(MQTTClient handle, void* context, MQTTClient_disconnected* co);
457
481typedef void MQTTClient_published(void* context, int dt, int packet_type, MQTTProperties* properties,
482 enum MQTTReasonCodes reasonCode);
483
484LIBMQTT_API int MQTTClient_setPublished(MQTTClient handle, void* context, MQTTClient_published* co);
485
528LIBMQTT_API int MQTTClient_create(MQTTClient* handle, const char* serverURI, const char* clientId,
529 int persistence_type, void* persistence_context);
530
532typedef struct
533{
535 char struct_id[4];
545
546#define MQTTClient_createOptions_initializer { {'M', 'Q', 'C', 'O'}, 0, MQTTVERSION_DEFAULT }
547
592LIBMQTT_API int MQTTClient_createWithOptions(MQTTClient* handle, const char* serverURI, const char* clientId,
593 int persistence_type, void* persistence_context, MQTTClient_createOptions* options);
594
607typedef struct
608{
610 char struct_id[4];
616 const char* topicName;
618 const char* message;
627 int qos;
629 struct
630 {
631 int len;
632 const void* data;
633 } payload;
635
636#define MQTTClient_willOptions_initializer { {'M', 'Q', 'T', 'W'}, 1, NULL, NULL, 0, 0, {0, NULL} }
637
638#define MQTT_SSL_VERSION_DEFAULT 0
639#define MQTT_SSL_VERSION_TLS_1_0 1
640#define MQTT_SSL_VERSION_TLS_1_1 2
641#define MQTT_SSL_VERSION_TLS_1_2 3
642
655typedef struct
656{
658 char struct_id[4];
661
663 const char* trustStore;
664
668 const char* keyStore;
669
673 const char* privateKey;
676
686
689
695
702
708 const char* CApath;
709
714 int (*ssl_error_cb) (const char *str, size_t len, void *u);
715
721
727 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);
728
734
741
743
744#define MQTTClient_SSLOptions_initializer { {'M', 'Q', 'T', 'S'}, 4, NULL, NULL, NULL, NULL, NULL, 1, MQTT_SSL_VERSION_DEFAULT, 0, NULL, NULL, NULL, NULL, NULL, 0 }
745
753typedef struct
754{
755 const char* name;
756 const char* value;
758
765
780typedef struct
781{
783 char struct_id[4];
847 const char* username;
853 const char* password;
885 char* const* serverURIs;
897 struct
898 {
899 const char* serverURI;
900 int MQTTVersion;
902 } returned;
906 struct
907 {
908 int len;
909 const void* data;
910 } binarypwd;
919 /*
920 * MQTT V5 clean start flag. Only clears state at the beginning of the session.
921 */
924
925#define MQTTClient_connectOptions_initializer { {'M', 'Q', 'T', 'C'}, 7, 60, 1, 1, NULL, NULL, NULL, 30, 0, NULL, 0, NULL, MQTTVERSION_DEFAULT, {NULL, 0, 0}, {0, NULL}, NULL, -1, 0}
926
927#define MQTTClient_connectOptions_initializer5 { {'M', 'Q', 'T', 'C'}, 7, 60, 0, 1, NULL, NULL, NULL, 30, 0, NULL, 0, NULL, MQTTVERSION_5, {NULL, 0, 0}, {0, NULL}, NULL, -1, 1}
928
950
952typedef struct MQTTResponse
953{
954 int version; /* the version number of this structure */
955 enum MQTTReasonCodes reasonCode; /* the MQTT 5.0 reason code returned */
956 int reasonCodeCount; /* the number of reason codes. Used for subscribeMany5 and unsubscribeMany5 */
957 enum MQTTReasonCodes* reasonCodes; /* a list of reason codes. Used for subscribeMany5 and unsubscribeMany5 */
958 MQTTProperties* properties; /* optionally, the MQTT 5.0 properties returned */
960
961#define MQTTResponse_initializer {1, MQTTREASONCODE_SUCCESS, 0, NULL, NULL}
962
967LIBMQTT_API void MQTTResponse_free(MQTTResponse response);
968
982 MQTTProperties* connectProperties, MQTTProperties* willProperties);
983
1002LIBMQTT_API int MQTTClient_disconnect(MQTTClient handle, int timeout);
1003
1004LIBMQTT_API int MQTTClient_disconnect5(MQTTClient handle, int timeout, enum MQTTReasonCodes reason, MQTTProperties* props);
1005
1013LIBMQTT_API int MQTTClient_isConnected(MQTTClient handle);
1014
1015
1016/* Subscribe is synchronous. QoS list parameter is changed on return to granted QoSs.
1017 Returns return code, MQTTCLIENT_SUCCESS == success, non-zero some sort of error (TBD) */
1018
1032LIBMQTT_API int MQTTClient_subscribe(MQTTClient handle, const char* topic, int qos);
1033
1047LIBMQTT_API MQTTResponse MQTTClient_subscribe5(MQTTClient handle, const char* topic, int qos,
1049
1066LIBMQTT_API int MQTTClient_subscribeMany(MQTTClient handle, int count, char* const* topic, int* qos);
1067
1084LIBMQTT_API MQTTResponse MQTTClient_subscribeMany5(MQTTClient handle, int count, char* const* topic,
1085 int* qos, MQTTSubscribe_options* opts, MQTTProperties* props);
1086
1098LIBMQTT_API int MQTTClient_unsubscribe(MQTTClient handle, const char* topic);
1099
1110LIBMQTT_API MQTTResponse MQTTClient_unsubscribe5(MQTTClient handle, const char* topic, MQTTProperties* props);
1111
1123LIBMQTT_API int MQTTClient_unsubscribeMany(MQTTClient handle, int count, char* const* topic);
1124
1136LIBMQTT_API MQTTResponse MQTTClient_unsubscribeMany5(MQTTClient handle, int count, char* const* topic, MQTTProperties* props);
1137
1159LIBMQTT_API int MQTTClient_publish(MQTTClient handle, const char* topicName, int payloadlen, const void* payload, int qos, int retained,
1161
1183LIBMQTT_API MQTTResponse MQTTClient_publish5(MQTTClient handle, const char* topicName, int payloadlen, const void* payload,
1184 int qos, int retained, MQTTProperties* properties, MQTTClient_deliveryToken* dt);
1204LIBMQTT_API int MQTTClient_publishMessage(MQTTClient handle, const char* topicName, MQTTClient_message* msg, MQTTClient_deliveryToken* dt);
1205
1206
1226LIBMQTT_API MQTTResponse MQTTClient_publishMessage5(MQTTClient handle, const char* topicName, MQTTClient_message* msg,
1228
1244LIBMQTT_API int MQTTClient_waitForCompletion(MQTTClient handle, MQTTClient_deliveryToken dt, unsigned long timeout);
1245
1246
1266
1273LIBMQTT_API void MQTTClient_yield(void);
1274
1306LIBMQTT_API int MQTTClient_receive(MQTTClient handle, char** topicName, int* topicLen, MQTTClient_message** message,
1307 unsigned long timeout);
1308
1320
1329LIBMQTT_API void MQTTClient_free(void* ptr);
1330
1338LIBMQTT_API void MQTTClient_destroy(MQTTClient* handle);
1339
1340
1342{
1350};
1351
1352
1359
1360
1369typedef void MQTTClient_traceCallback(enum MQTTCLIENT_TRACE_LEVELS level, char* message);
1370
1378
1384LIBMQTT_API const char* MQTTClient_strerror(int code);
1385
1386#ifdef __cplusplus
1387 }
1388#endif
1389
1390#endif
1391
void MQTTResponse_free(MQTTResponse response)
struct MQTTResponse MQTTResponse
int MQTTClient_disconnect5(MQTTClient handle, int timeout, enum MQTTReasonCodes reason, MQTTProperties *props)
int MQTTClient_disconnect(MQTTClient handle, int timeout)
void MQTTClient_free(void *ptr)
void MQTTClient_global_init(MQTTClient_init_options *inits)
void MQTTClient_setTraceCallback(MQTTClient_traceCallback *callback)
int MQTTClient_getPendingDeliveryTokens(MQTTClient handle, MQTTClient_deliveryToken **tokens)
MQTTResponse MQTTClient_publishMessage5(MQTTClient handle, const char *topicName, MQTTClient_message *msg, MQTTClient_deliveryToken *dt)
void MQTTClient_disconnected(void *context, MQTTProperties *properties, enum MQTTReasonCodes reasonCode)
Definition: MQTTClient.h:440
MQTTResponse MQTTClient_unsubscribeMany5(MQTTClient handle, int count, char *const *topic, MQTTProperties *props)
int MQTTClient_receive(MQTTClient handle, char **topicName, int *topicLen, MQTTClient_message **message, unsigned long timeout)
void MQTTClient_setTraceLevel(enum MQTTCLIENT_TRACE_LEVELS level)
int MQTTClient_unsubscribeMany(MQTTClient handle, int count, char *const *topic)
MQTTResponse MQTTClient_subscribeMany5(MQTTClient handle, int count, char *const *topic, int *qos, MQTTSubscribe_options *opts, MQTTProperties *props)
MQTTResponse MQTTClient_unsubscribe5(MQTTClient handle, const char *topic, MQTTProperties *props)
const char * MQTTClient_strerror(int code)
void MQTTClient_connectionLost(void *context, char *cause)
Definition: MQTTClient.h:398
void MQTTClient_published(void *context, int dt, int packet_type, MQTTProperties *properties, enum MQTTReasonCodes reasonCode)
Definition: MQTTClient.h:481
int MQTTClient_isConnected(MQTTClient handle)
int MQTTClient_deliveryToken
Definition: MQTTClient.h:257
void * MQTTClient
Definition: MQTTClient.h:246
MQTTResponse MQTTClient_publish5(MQTTClient handle, const char *topicName, int payloadlen, const void *payload, int qos, int retained, MQTTProperties *properties, MQTTClient_deliveryToken *dt)
int MQTTClient_waitForCompletion(MQTTClient handle, MQTTClient_deliveryToken dt, unsigned long timeout)
void MQTTClient_yield(void)
int MQTTClient_setDisconnected(MQTTClient handle, void *context, MQTTClient_disconnected *co)
int MQTTClient_token
Definition: MQTTClient.h:258
int MQTTClient_subscribeMany(MQTTClient handle, int count, char *const *topic, int *qos)
int MQTTClient_create(MQTTClient *handle, const char *serverURI, const char *clientId, int persistence_type, void *persistence_context)
int MQTTClient_subscribe(MQTTClient handle, const char *topic, int qos)
int MQTTClient_setPublished(MQTTClient handle, void *context, MQTTClient_published *co)
MQTTCLIENT_TRACE_LEVELS
Definition: MQTTClient.h:1342
@ MQTTCLIENT_TRACE_PROTOCOL
Definition: MQTTClient.h:1346
@ MQTTCLIENT_TRACE_FATAL
Definition: MQTTClient.h:1349
@ MQTTCLIENT_TRACE_MAXIMUM
Definition: MQTTClient.h:1343
@ MQTTCLIENT_TRACE_MEDIUM
Definition: MQTTClient.h:1344
@ MQTTCLIENT_TRACE_ERROR
Definition: MQTTClient.h:1347
@ MQTTCLIENT_TRACE_MINIMUM
Definition: MQTTClient.h:1345
@ MQTTCLIENT_TRACE_SEVERE
Definition: MQTTClient.h:1348
int MQTTClient_messageArrived(void *context, char *topicName, int topicLen, MQTTClient_message *message)
Definition: MQTTClient.h:359
MQTTResponse MQTTClient_connect5(MQTTClient handle, MQTTClient_connectOptions *options, MQTTProperties *connectProperties, MQTTProperties *willProperties)
int MQTTClient_unsubscribe(MQTTClient handle, const char *topic)
int MQTTClient_connect(MQTTClient handle, MQTTClient_connectOptions *options)
int MQTTClient_setCallbacks(MQTTClient handle, void *context, MQTTClient_connectionLost *cl, MQTTClient_messageArrived *ma, MQTTClient_deliveryComplete *dc)
void MQTTClient_freeMessage(MQTTClient_message **msg)
void MQTTClient_deliveryComplete(void *context, MQTTClient_deliveryToken dt)
Definition: MQTTClient.h:381
int MQTTClient_publishMessage(MQTTClient handle, const char *topicName, MQTTClient_message *msg, MQTTClient_deliveryToken *dt)
int MQTTClient_createWithOptions(MQTTClient *handle, const char *serverURI, const char *clientId, int persistence_type, void *persistence_context, MQTTClient_createOptions *options)
void MQTTClient_destroy(MQTTClient *handle)
MQTTClient_nameValue * MQTTClient_getVersionInfo(void)
MQTTResponse MQTTClient_subscribe5(MQTTClient handle, const char *topic, int qos, MQTTSubscribe_options *opts, MQTTProperties *props)
void MQTTClient_traceCallback(enum MQTTCLIENT_TRACE_LEVELS level, char *message)
Definition: MQTTClient.h:1369
int MQTTClient_publish(MQTTClient handle, const char *topicName, int payloadlen, const void *payload, int qos, int retained, MQTTClient_deliveryToken *dt)
This structure represents a persistent data store, used to store outbound and inbound messages,...
MQTTReasonCodes
Definition: MQTTReasonCodes.h:23
Definition: MQTTClient.h:656
const char * trustStore
Definition: MQTTClient.h:663
int struct_version
Definition: MQTTClient.h:660
int disableDefaultTrustStore
Definition: MQTTClient.h:740
void * ssl_error_context
Definition: MQTTClient.h:720
const char * CApath
Definition: MQTTClient.h:708
const char * keyStore
Definition: MQTTClient.h:668
int sslVersion
Definition: MQTTClient.h:694
int enableServerCertAuth
Definition: MQTTClient.h:688
const char * privateKey
Definition: MQTTClient.h:673
int verify
Definition: MQTTClient.h:701
const char * enabledCipherSuites
Definition: MQTTClient.h:685
void * ssl_psk_context
Definition: MQTTClient.h:733
const char * privateKeyPassword
Definition: MQTTClient.h:675
Definition: MQTTClient.h:781
const MQTTClient_nameValue * httpHeaders
Definition: MQTTClient.h:914
int cleansession
Definition: MQTTClient.h:825
int struct_version
Definition: MQTTClient.h:793
MQTTClient_willOptions * will
Definition: MQTTClient.h:841
const void * data
Definition: MQTTClient.h:909
int MQTTVersion
Definition: MQTTClient.h:893
const char * serverURI
Definition: MQTTClient.h:899
int connectTimeout
Definition: MQTTClient.h:857
int sessionPresent
Definition: MQTTClient.h:901
MQTTClient_SSLOptions * ssl
Definition: MQTTClient.h:870
int reliable
Definition: MQTTClient.h:835
const char * password
Definition: MQTTClient.h:853
int serverURIcount
Definition: MQTTClient.h:874
char *const * serverURIs
Definition: MQTTClient.h:885
const char * username
Definition: MQTTClient.h:847
int retryInterval
Definition: MQTTClient.h:865
int keepAliveInterval
Definition: MQTTClient.h:803
int cleanstart
Definition: MQTTClient.h:922
int maxInflightMessages
Definition: MQTTClient.h:918
int len
Definition: MQTTClient.h:908
Definition: MQTTClient.h:533
int struct_version
Definition: MQTTClient.h:537
int MQTTVersion
Definition: MQTTClient.h:543
Definition: MQTTClient.h:225
int struct_version
Definition: MQTTClient.h:229
int do_openssl_init
Definition: MQTTClient.h:231
Definition: MQTTClient.h:267
int struct_version
Definition: MQTTClient.h:272
MQTTProperties properties
Definition: MQTTClient.h:324
int qos
Definition: MQTTClient.h:290
int msgid
Definition: MQTTClient.h:320
int retained
Definition: MQTTClient.h:309
void * payload
Definition: MQTTClient.h:276
int payloadlen
Definition: MQTTClient.h:274
int dup
Definition: MQTTClient.h:316
Definition: MQTTClient.h:754
const char * value
Definition: MQTTClient.h:756
const char * name
Definition: MQTTClient.h:755
Definition: MQTTClient.h:608
int struct_version
Definition: MQTTClient.h:614
const void * data
Definition: MQTTClient.h:632
const char * topicName
Definition: MQTTClient.h:616
const char * message
Definition: MQTTClient.h:618
int qos
Definition: MQTTClient.h:627
int retained
Definition: MQTTClient.h:622
int len
Definition: MQTTClient.h:631
Definition: MQTTProperties.h:113
Definition: MQTTClient.h:953
enum MQTTReasonCodes * reasonCodes
Definition: MQTTClient.h:957
enum MQTTReasonCodes reasonCode
Definition: MQTTClient.h:955
MQTTProperties * properties
Definition: MQTTClient.h:958
int version
Definition: MQTTClient.h:954
int reasonCodeCount
Definition: MQTTClient.h:956
Definition: MQTTSubscribeOpts.h:22