1.1.11.1 WDRV_WINC_MQTTUnsubscribe

Function

WDRV_WINC_STATUS WDRV_WINC_MQTTUnsubscribe
(
DRV_HANDLE handle,
const char* pTopicName
)

Summary

Un-subscribe from an MQTT topic.

Description

Sends a request to un-subscribe from an MQTT topic.

Precondition

WDRV_WINC_Initialize should have been called. WDRV_WINC_Open should have been called to obtain a valid handle. WDRV_WINC_MQTTConnect should have been called to connect to a broker.

Parameters

handle - Client handle obtained by a call to WDRV_WINC_Open.

pTopicName - Pointer to topic name to un-subscribe from.

Returns

WDRV_WINC_STATUS_OK - A scan was initiated.

WDRV_WINC_STATUS_NOT_OPEN - The driver instance is not open.

WDRV_WINC_STATUS_REQUEST_ERROR - The request to the WINC was rejected.

WDRV_WINC_STATUS_INVALID_ARG - The parameters were incorrect.

Remarks

None.