aws_iot_mqtt_client_unsubscribe.c File Reference

MQTT client unsubscribe API definitions. More...

#include "aws_iot_mqtt_client_common_internal.h"

Functions
IoT_Error_t	aws_iot_mqtt_unsubscribe (AWS_IoT_Client *pClient, const char *pTopicFilter, uint16_t topicFilterLen)
	Unsubscribe to an MQTT topic. More...

Detailed Description

MQTT client unsubscribe API definitions.

Function Documentation

aws_iot_mqtt_unsubscribe()

IoT_Error_t aws_iot_mqtt_unsubscribe	(	AWS_IoT_Client *	pClient,
		const char *	pTopicFilter,
		uint16_t	topicFilterLen
	)

Unsubscribe to an MQTT topic.

Called to send an unsubscribe message to the broker requesting removal of a subscription to an MQTT topic.

Note

Call is blocking. The call returns after the receipt of the UNSUBACK control packet.

Parameters

pClient	Reference to the IoT Client
pTopicFilter	Topic filter of subscription
topicFilterLen	Length of the topic filter

Returns

An IoT Error Type defining successful/failed unsubscribe call