aws_iot_mqtt_client_yield.c File Reference

This is for the case when the aws_iot_mqtt_internal_send_packet Fails.

Definition at line 47 of file aws_iot_mqtt_client_yield.c.

Yield to the MQTT client.

Called to yield the current thread to the underlying MQTT client. This time is used by the MQTT client to manage PING requests to monitor the health of the TCP connection as well as periodically check the socket receive buffer for subscribe messages. Yield() must be called at a rate faster than the keepalive interval. It must also be called at a rate faster than the incoming message rate as this is the only way the client receives processing time to manage incoming messages. This is the internal function which is called by the yield API to perform the operation. Not meant to be called directly as it doesn't do validations or client state changes

Parameters:

pClient	Reference to the IoT Client
timeout_ms	Maximum number of milliseconds to pass thread execution to the client.

Returns:

An IoT Error Type defining successful/failed client processing. If this call results in an error it is likely the MQTT connection has dropped. iot_is_mqtt_connected can be called to confirm.

Definition at line 183 of file aws_iot_mqtt_client_yield.c.

Yield to the MQTT client.

Called to yield the current thread to the underlying MQTT client. This time is used by the MQTT client to manage PING requests to monitor the health of the TCP connection as well as periodically check the socket receive buffer for subscribe messages. Yield() must be called at a rate faster than the keepalive interval. It must also be called at a rate faster than the incoming message rate as this is the only way the client receives processing time to manage incoming messages. This is the outer function which does the validations and calls the internal yield above to perform the actual operation. It is also responsible for client state changes

Parameters:

pClient	Reference to the IoT Client
timeout_ms	Maximum number of milliseconds to pass thread execution to the client.

Returns:

An IoT Error Type defining successful/failed client processing. If this call results in an error it is likely the MQTT connection has dropped. iot_is_mqtt_connected can be called to confirm.

Definition at line 271 of file aws_iot_mqtt_client_yield.c.