 |
Paho MQTT C Client Library
|
Go to the documentation of this file.
107 #if !defined(MQTTCLIENT_H)
110 #if defined(__cplusplus)
119 #include "MQTTExportDeclarations.h"
124 #if !defined(NO_PERSISTENCE)
132 #define MQTTCLIENT_SUCCESS 0
137 #define MQTTCLIENT_FAILURE -1
144 #define MQTTCLIENT_DISCONNECTED -3
149 #define MQTTCLIENT_MAX_MESSAGES_INFLIGHT -4
153 #define MQTTCLIENT_BAD_UTF8_STRING -5
157 #define MQTTCLIENT_NULL_PARAMETER -6
163 #define MQTTCLIENT_TOPICNAME_TRUNCATED -7
168 #define MQTTCLIENT_BAD_STRUCTURE -8
172 #define MQTTCLIENT_BAD_QOS -9
176 #define MQTTCLIENT_SSL_NOT_SUPPORTED -10
180 #define MQTTCLIENT_BAD_MQTT_VERSION -11
186 #define MQTTCLIENT_BAD_PROTOCOL -14
190 #define MQTTCLIENT_BAD_MQTT_OPTION -15
194 #define MQTTCLIENT_WRONG_MQTT_VERSION -16
198 #define MQTTCLIENT_0_LEN_WILL_TOPIC -17
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
235 #define MQTTClient_init_options_initializer { {'M', 'Q', 'T', 'G'}, 0, 0 }
328 #define MQTTClient_message_initializer { {'M', 'Q', 'T', 'M'}, 1, 0, NULL, 0, 0, 0, 0, MQTTProperties_initializer }
533 int persistence_type,
void* persistence_context);
550 #define MQTTClient_createOptions_initializer { {'M', 'Q', 'C', 'O'}, 0, MQTTVERSION_DEFAULT }
640 #define MQTTClient_willOptions_initializer { {'M', 'Q', 'T', 'W'}, 1, NULL, NULL, 0, 0, {0, NULL} }
642 #define MQTT_SSL_VERSION_DEFAULT 0
643 #define MQTT_SSL_VERSION_TLS_1_0 1
644 #define MQTT_SSL_VERSION_TLS_1_1 2
645 #define MQTT_SSL_VERSION_TLS_1_2 3
726 int (*ssl_error_cb) (
const char *str,
size_t len,
void *u);
739 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);
770 #define MQTTClient_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 }
963 #define MQTTClient_connectOptions_initializer { {'M', 'Q', 'T', 'C'}, 8, 60, 1, 1, NULL, NULL, NULL, 30, 0, NULL,\
964 0, NULL, MQTTVERSION_DEFAULT, {NULL, 0, 0}, {0, NULL}, -1, 0, NULL, NULL, NULL}
966 #define MQTTClient_connectOptions_initializer5 { {'M', 'Q', 'T', 'C'}, 8, 60, 0, 1, NULL, NULL, NULL, 30, 0, NULL,\
967 0, NULL, MQTTVERSION_5, {NULL, 0, 0}, {0, NULL}, -1, 1, NULL, NULL, NULL}
969 #define MQTTClient_connectOptions_initializer_ws { {'M', 'Q', 'T', 'C'}, 8, 45, 1, 1, NULL, NULL, NULL, 30, 0, NULL,\
970 0, NULL, MQTTVERSION_DEFAULT, {NULL, 0, 0}, {0, NULL}, -1, 0, NULL, NULL, NULL}
972 #define MQTTClient_connectOptions_initializer5_ws { {'M', 'Q', 'T', 'C'}, 8, 45, 0, 1, NULL, NULL, NULL, 30, 0, NULL,\
973 0, NULL, MQTTVERSION_5, {NULL, 0, 0}, {0, NULL}, -1, 1, NULL, NULL, NULL}
1007 #define MQTTResponse_initializer {1, MQTTREASONCODE_SUCCESS, 0, NULL, NULL}
1206 LIBMQTT_API
int MQTTClient_publish(
MQTTClient handle,
const char* topicName,
int payloadlen,
const void* payload,
int qos,
int retained,
1354 unsigned long timeout);
1443 #if defined(__cplusplus)
int qos
Definition: MQTTClient.h:631
enum MQTTReasonCodes reasonCode
Definition: MQTTClient.h:1001
@ MQTTCLIENT_TRACE_MEDIUM
Definition: MQTTClient.h:1391
int do_openssl_init
Definition: MQTTClient.h:232
int retained
Definition: MQTTClient.h:310
int MQTTClient_publish(MQTTClient handle, const char *topicName, int payloadlen, const void *payload, int qos, int retained, MQTTClient_deliveryToken *dt)
const void * data
Definition: MQTTClient.h:636
const char * trustStore
Definition: MQTTClient.h:674
int MQTTClient_subscribeMany(MQTTClient handle, int count, char *const *topic, int *qos)
const unsigned char * protos
Definition: MQTTClient.h:761
int MQTTClient_setDisconnected(MQTTClient handle, void *context, MQTTClient_disconnected *co)
@ MQTTCLIENT_TRACE_PROTOCOL
Definition: MQTTClient.h:1393
const char * MQTTClient_strerror(int code)
void * ssl_psk_context
Definition: MQTTClient.h:745
int keepAliveInterval
Definition: MQTTClient.h:830
int payloadlen
Definition: MQTTClient.h:275
Definition: MQTTProperties.h:112
MQTTClient_willOptions * will
Definition: MQTTClient.h:868
int retryInterval
Definition: MQTTClient.h:892
void * ssl_error_context
Definition: MQTTClient.h:732
void MQTTClient_setTraceCallback(MQTTClient_traceCallback *callback)
Definition: MQTTClient.h:536
int MQTTClient_unsubscribe(MQTTClient handle, const char *topic)
const char * message
Definition: MQTTClient.h:622
const MQTTClient_nameValue * httpHeaders
Definition: MQTTClient.h:952
const char * value
Definition: MQTTClient.h:782
int MQTTClient_receive(MQTTClient handle, char **topicName, int *topicLen, MQTTClient_message **message, unsigned long timeout)
int MQTTClient_messageArrived(void *context, char *topicName, int topicLen, MQTTClient_message *message)
Definition: MQTTClient.h:360
void MQTTClient_freeMessage(MQTTClient_message **msg)
MQTTResponse MQTTClient_unsubscribe5(MQTTClient handle, const char *topic, MQTTProperties *props)
const char * name
Definition: MQTTClient.h:781
int struct_version
Definition: MQTTClient.h:618
int disableDefaultTrustStore
Definition: MQTTClient.h:752
MQTTResponse MQTTClient_publish5(MQTTClient handle, const char *topicName, int payloadlen, const void *payload, int qos, int retained, MQTTProperties *properties, MQTTClient_deliveryToken *dt)
int cleanstart
Definition: MQTTClient.h:948
int sessionPresent
Definition: MQTTClient.h:931
Definition: MQTTClient.h:267
const char * serverURI
Definition: MQTTClient.h:929
MQTTResponse MQTTClient_subscribe5(MQTTClient handle, const char *topic, int qos, MQTTSubscribe_options *opts, MQTTProperties *props)
char *const * serverURIs
Definition: MQTTClient.h:915
Definition: MQTTClient.h:659
MQTTProperties properties
Definition: MQTTClient.h:325
int qos
Definition: MQTTClient.h:291
void MQTTClient_yield(void)
int struct_version
Definition: MQTTClient.h:541
@ MQTTCLIENT_TRACE_ERROR
Definition: MQTTClient.h:1394
int maxInflightMessages
Definition: MQTTClient.h:944
void MQTTClient_deliveryComplete(void *context, MQTTClient_deliveryToken dt)
Definition: MQTTClient.h:382
int MQTTClient_token
Definition: MQTTClient.h:259
int struct_version
Definition: MQTTClient.h:820
void MQTTClient_setTraceLevel(enum MQTTCLIENT_TRACE_LEVELS level)
@ MQTTCLIENT_TRACE_FATAL
Definition: MQTTClient.h:1396
void MQTTClient_traceCallback(enum MQTTCLIENT_TRACE_LEVELS level, char *message)
Definition: MQTTClient.h:1417
int serverURIcount
Definition: MQTTClient.h:901
int MQTTClient_subscribe(MQTTClient handle, const char *topic, int qos)
int MQTTClient_deliveryToken
Definition: MQTTClient.h:258
int MQTTClient_waitForCompletion(MQTTClient handle, MQTTClient_deliveryToken dt, unsigned long timeout)
int MQTTClient_setCallbacks(MQTTClient handle, void *context, MQTTClient_connectionLost *cl, MQTTClient_messageArrived *ma, MQTTClient_deliveryComplete *dc)
const char * password
Definition: MQTTClient.h:880
Definition: MQTTClient.h:611
const char * privateKeyPassword
Definition: MQTTClient.h:687
const void * data
Definition: MQTTClient.h:939
void MQTTClient_global_init(MQTTClient_init_options *inits)
void MQTTClient_connectionLost(void *context, char *cause)
Definition: MQTTClient.h:399
void MQTTClient_published(void *context, int dt, int packet_type, MQTTProperties *properties, enum MQTTReasonCodes reasonCode)
Definition: MQTTClient.h:483
void * payload
Definition: MQTTClient.h:277
void MQTTResponse_free(MQTTResponse response)
struct MQTTResponse MQTTResponse
int MQTTVersion
Definition: MQTTClient.h:923
MQTTProperties * properties
Definition: MQTTClient.h:1004
const char * CApath
Definition: MQTTClient.h:720
int msgid
Definition: MQTTClient.h:321
const char * topicName
Definition: MQTTClient.h:620
void * MQTTClient
Definition: MQTTClient.h:247
int MQTTClient_getPendingDeliveryTokens(MQTTClient handle, MQTTClient_deliveryToken **tokens)
Definition: MQTTClient.h:998
int MQTTClient_unsubscribeMany(MQTTClient handle, int count, char *const *topic)
const char * keyStore
Definition: MQTTClient.h:679
void MQTTClient_disconnected(void *context, MQTTProperties *properties, enum MQTTReasonCodes reasonCode)
Definition: MQTTClient.h:442
int struct_version
Definition: MQTTClient.h:273
MQTTResponse MQTTClient_publishMessage5(MQTTClient handle, const char *topicName, MQTTClient_message *msg, MQTTClient_deliveryToken *dt)
int verify
Definition: MQTTClient.h:713
const char * username
Definition: MQTTClient.h:874
@ MQTTCLIENT_TRACE_MAXIMUM
Definition: MQTTClient.h:1390
unsigned int protos_len
Definition: MQTTClient.h:767
@ MQTTCLIENT_TRACE_MINIMUM
Definition: MQTTClient.h:1392
MQTTCLIENT_TRACE_LEVELS
Definition: MQTTClient.h:1388
int MQTTClient_setCommandTimeout(MQTTClient handle, unsigned long milliSeconds)
Definition: MQTTSubscribeOpts.h:21
MQTTClient_nameValue * MQTTClient_getVersionInfo(void)
int len
Definition: MQTTClient.h:938
void MQTTClient_destroy(MQTTClient *handle)
Definition: MQTTClient.h:806
int MQTTClient_publishMessage(MQTTClient handle, const char *topicName, MQTTClient_message *msg, MQTTClient_deliveryToken *dt)
int MQTTClient_connect(MQTTClient handle, MQTTClient_connectOptions *options)
int struct_version
Definition: MQTTClient.h:671
int MQTTClient_createWithOptions(MQTTClient *handle, const char *serverURI, const char *clientId, int persistence_type, void *persistence_context, MQTTClient_createOptions *options)
Definition: MQTTClient.h:779
int MQTTClient_setPublished(MQTTClient handle, void *context, MQTTClient_published *co)
int dup
Definition: MQTTClient.h:317
MQTTResponse MQTTClient_subscribeMany5(MQTTClient handle, int count, char *const *topic, int *qos, MQTTSubscribe_options *opts, MQTTProperties *props)
const char * httpsProxy
Definition: MQTTClient.h:960
Definition: MQTTClient.h:225
enum MQTTReasonCodes * reasonCodes
Definition: MQTTClient.h:1003
int enableServerCertAuth
Definition: MQTTClient.h:700
MQTTResponse MQTTClient_unsubscribeMany5(MQTTClient handle, int count, char *const *topic, MQTTProperties *props)
const char * privateKey
Definition: MQTTClient.h:684
@ MQTTCLIENT_TRACE_SEVERE
Definition: MQTTClient.h:1395
int MQTTClient_disconnect(MQTTClient handle, int timeout)
int reasonCodeCount
Definition: MQTTClient.h:1002
int retained
Definition: MQTTClient.h:626
int reliable
Definition: MQTTClient.h:862
int version
Definition: MQTTClient.h:1000
int sslVersion
Definition: MQTTClient.h:706
MQTTResponse MQTTClient_connect5(MQTTClient handle, MQTTClient_connectOptions *options, MQTTProperties *connectProperties, MQTTProperties *willProperties)
int cleansession
Definition: MQTTClient.h:852
int MQTTVersion
Definition: MQTTClient.h:547
const char * enabledCipherSuites
Definition: MQTTClient.h:697
This structure represents a persistent data store, used to store outbound and inbound messages,...
const char * httpProxy
Definition: MQTTClient.h:956
int MQTTClient_disconnect5(MQTTClient handle, int timeout, enum MQTTReasonCodes reason, MQTTProperties *props)
MQTTClient_SSLOptions * ssl
Definition: MQTTClient.h:897
int struct_version
Definition: MQTTClient.h:230
void MQTTClient_free(void *ptr)
int MQTTClient_isConnected(MQTTClient handle)
MQTTReasonCodes
Definition: MQTTReasonCodes.h:23
int len
Definition: MQTTClient.h:635
int connectTimeout
Definition: MQTTClient.h:884
int MQTTClient_create(MQTTClient *handle, const char *serverURI, const char *clientId, int persistence_type, void *persistence_context)