MQTT API Reference
MQTT 3.1.1 client library
IotMqtt_UnsubscribeSync

Unsubscribes from a given array of topic filters with a timeout.

const IotMqttSubscription_t * pSubscriptionList,
size_t subscriptionCount,
uint32_t flags,
uint32_t timeoutMs );

This function sends an MQTT UNSUBSCRIBE packet to the server, then waits for a server response to the packet. Internally, this function is a call to IotMqtt_UnsubscribeAsync followed by IotMqtt_Wait. See IotMqtt_UnsubscribeAsync for more information about the MQTT UNSUBSCRIBE operation.

Parameters
[in]mqttConnectionThe MQTT connection used for the subscription.
[in]pSubscriptionListPointer to the first element in the array of subscriptions.
[in]subscriptionCountThe number of elements in pSubscriptionList.
[in]flagsFlags which modify the behavior of this function. See MQTT Function Flags. Flags are currently ignored but reserved for future use.
[in]timeoutMsIf the MQTT server does not acknowledge the UNSUBSCRIBE within this timeout in milliseconds, this function returns IOT_MQTT_TIMEOUT.
Returns
One of the following:
IotMqttError_t
IotMqttError_t
Return codes of MQTT functions.
Definition: iot_mqtt_types.h:103
IotMqttConnection_t
struct _mqttConnection * IotMqttConnection_t
Opaque handle of an MQTT connection.
Definition: iot_mqtt_types.h:66
IotMqttSubscription_t
MQTT subscription.
Definition: iot_mqtt_types.h:541
IotMqtt_UnsubscribeSync
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:1581