1.1.18.15 WDRV_WINC_MQTTDisconnect

C

WDRV_WINC_STATUS WDRV_WINC_MQTTDisconnect
(
    DRV_HANDLE handle,
    WDRV_WINC_MQTT_DISCONN_REASON_CODE_TYPE reasonCode
)

Description

Starts the process of disconnecting from an MQTT broker.

Precondition

WDRV_WINC_Initialize must have been called.

WDRV_WINC_Open must have been called to obtain a valid handle.

Parameters

ParametersDescription
handleClient handle obtained by a call to WDRV_WINC_Open.
reasonCodeReason code to pass on, if supported.

Returns

  • WDRV_WINC_STATUS_OK - A disconnect request was sent.

  • 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.