1.2.3.17 SYS_MQTT_GetStatus Function

C

SYS_MQTT_STATUS SYS_MQTT_GetStatus ( SYS_MODULE_OBJ object )

Summary

Returns System MQTT instance status.

Description

This function returns the current status of the System MQTT instance.

Precondition

SYS_MQTT_Connect should have been called before calling this function

Parameters

ParamDescription
objectSYS MQTT object handle, returned from SYS_MQTT_Connect

Returns

SYS_MQTT_STATUS

Example

// Handle "objSysMqtt" value must have been returned from SYS_MQTT_Connect.
if (SYS_MQTT_GetStatus (objSysMqtt) == SYS_MQTT_STATUS_WAIT_FOR_MQTT_CONACK)
{
    // MQTT system service is initialized, and Waiting for the Connect Ack
    // from the Broker for the Connect Packet sent by DUT to it.
}

Remarks

None.