aws_iot_mqtt_client_yield.c File Reference

MQTT client yield API definitions. More...

#include "aws_iot_mqtt_client_common_internal.h"

Functions
IoT_Error_t	aws_iot_mqtt_yield (AWS_IoT_Client *pClient, uint32_t timeout_ms)
	Yield to the MQTT client. More...

Detailed Description

MQTT client yield API definitions.

Function Documentation

aws_iot_mqtt_yield()

IoT_Error_t aws_iot_mqtt_yield	(	AWS_IoT_Client *	pClient,
		uint32_t	timeout_ms
	)

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.

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.