MQTT API Reference
MQTT 3.1.1 client library
|
Go to the documentation of this file.
31 #include "iot_config.h"
125 void * pReceiveContext );
425 size_t subscriptionCount,
466 size_t subscriptionCount,
468 uint32_t timeoutMs );
512 size_t subscriptionCount,
549 size_t subscriptionCount,
551 uint32_t timeoutMs );
685 uint32_t timeoutMs );
739 uint32_t timeoutMs );
821 const char * pTopicFilter,
822 uint16_t topicFilterLength,
832 #define IotMqtt_Subscribe IotMqtt_SubscribeAsync
833 #define IotMqtt_TimedSubscribe IotMqtt_SubscribeSync
834 #define IotMqtt_Unsubscribe IotMqtt_UnsubscribeAsync
835 #define IotMqtt_TimedUnsubscribe IotMqtt_UnsubscribeSync
836 #define IotMqtt_Publish IotMqtt_PublishAsync
837 #define IotMqtt_TimedPublish IotMqtt_PublishSync
void IotMqtt_ReceiveCallback(void *pNetworkConnection, void *pReceiveContext)
Network receive callback for the MQTT library.
Definition: iot_mqtt_network.c:927
IotMqttError_t IotMqtt_SubscribeSync(IotMqttConnection_t mqttConnection, const IotMqttSubscription_t *pSubscriptionList, size_t subscriptionCount, uint32_t flags, uint32_t timeoutMs)
Subscribes to the given array of topic filters with a timeout.
Definition: iot_mqtt_api.c:1501
void IotMqtt_Cleanup(void)
One-time deinitialization function for the MQTT library.
Definition: iot_mqtt_api.c:951
void IotMqtt_Disconnect(IotMqttConnection_t mqttConnection, uint32_t flags)
Closes an MQTT connection and frees resources.
Definition: iot_mqtt_api.c:1327
IotMqttError_t
Return codes of MQTT functions.
Definition: iot_mqtt_types.h:103
Information on a user-provided MQTT callback function.
Definition: iot_mqtt_types.h:516
const char * IotMqtt_OperationType(IotMqttOperationType_t operation)
Returns a string that describes an IotMqttOperationType_t.
Definition: iot_mqtt_api.c:2100
IotMqttError_t IotMqtt_PublishAsync(IotMqttConnection_t mqttConnection, const IotMqttPublishInfo_t *pPublishInfo, uint32_t flags, const IotMqttCallbackInfo_t *pCallbackInfo, IotMqttOperation_t *const pPublishOperation)
Publishes a message to the given topic name and receive an asynchronous notification when the publish...
Definition: iot_mqtt_api.c:1595
struct _mqttOperation * IotMqttOperation_t
Opaque handle that references an in-progress MQTT operation.
Definition: iot_mqtt_types.h:88
IotMqttError_t IotMqtt_Init(void)
One-time initialization function for the MQTT library.
Definition: iot_mqtt_api.c:907
const char * IotMqtt_strerror(IotMqttError_t status)
Returns a string that describes an IotMqttError_t.
Definition: iot_mqtt_api.c:2036
IotMqttError_t IotMqtt_UnsubscribeAsync(IotMqttConnection_t mqttConnection, const IotMqttSubscription_t *pSubscriptionList, size_t subscriptionCount, uint32_t flags, const IotMqttCallbackInfo_t *pCallbackInfo, IotMqttOperation_t *const pUnsubscribeOperation)
Unsubscribes from the given array of topic filters and receive an asynchronous notification when the ...
Definition: iot_mqtt_api.c:1539
struct _mqttConnection * IotMqttConnection_t
Opaque handle of an MQTT connection.
Definition: iot_mqtt_types.h:66
Infomation on the transport-layer network connection for the new MQTT connection.
Definition: iot_mqtt_types.h:930
bool IotMqtt_IsSubscribed(IotMqttConnection_t mqttConnection, const char *pTopicFilter, uint16_t topicFilterLength, IotMqttSubscription_t *const pCurrentSubscription)
Check if an MQTT connection has a subscription for a topic filter.
Definition: iot_mqtt_subscription.c:584
Types of the MQTT library.
IotMqttOperationType_t
Types of MQTT operations.
Definition: iot_mqtt_types.h:277
Information on an MQTT subscription.
Definition: iot_mqtt_types.h:550
IotMqttError_t IotMqtt_UnsubscribeSync(IotMqttConnection_t mqttConnection, const IotMqttSubscription_t *pSubscriptionList, size_t subscriptionCount, uint32_t flags, uint32_t timeoutMs)
Unsubscribes from a given array of topic filters with a timeout.
Definition: iot_mqtt_api.c:1557
IotMqttError_t IotMqtt_PublishSync(IotMqttConnection_t mqttConnection, const IotMqttPublishInfo_t *pPublishInfo, uint32_t flags, uint32_t timeoutMs)
Publish a message to the given topic name with a timeout.
Definition: iot_mqtt_api.c:1866
IotMqttError_t IotMqtt_Wait(IotMqttOperation_t operation, uint32_t timeoutMs)
Waits for an operation to complete.
Definition: iot_mqtt_api.c:1918
Information on a PUBLISH message.
Definition: iot_mqtt_types.h:397
IotMqttError_t IotMqtt_SubscribeAsync(IotMqttConnection_t mqttConnection, const IotMqttSubscription_t *pSubscriptionList, size_t subscriptionCount, uint32_t flags, const IotMqttCallbackInfo_t *pCallbackInfo, IotMqttOperation_t *const pSubscribeOperation)
Subscribes to the given array of topic filters and receive an asynchronous notification when the subs...
Definition: iot_mqtt_api.c:1483
IotMqttError_t IotMqtt_Connect(const IotMqttNetworkInfo_t *pNetworkInfo, const IotMqttConnectInfo_t *pConnectInfo, uint32_t timeoutMs, IotMqttConnection_t *const pMqttConnection)
Establish a new MQTT connection.
Definition: iot_mqtt_api.c:975
Information on a new MQTT connection.
Definition: iot_mqtt_types.h:585