aws_iot_mqtt_client.c File Reference

Is the MQTT client set to reconnect automatically?

Called to determine if the MQTT client is set to reconnect automatically. Used to support logic in the device application around reconnecting

Parameters:

pClient

Reference to the IoT Client

Returns:

true = enabled, false = disabled

Definition at line 326 of file aws_iot_mqtt_client.c.

Enable or Disable AutoReconnect on Network Disconnect.

Called to enable or disabled the auto reconnect features provided with the SDK

Parameters:

pClient	Reference to the IoT Client
newStatus	set to true for enabling and false for disabling

Returns:

IoT_Error_t Type defining successful/failed API call

Definition at line 336 of file aws_iot_mqtt_client.c.

Clean mqtt client from all dynamic memory allocate.

This function will free up memory that was dynamically allocated for the client.

Parameters:

pClient

MQTT Client that was previously created by calling aws_iot_mqtt_init

Returns:

An IoT Error Type defining successful/failed freeing

Definition at line 172 of file aws_iot_mqtt_client.c.

Get the current state of the client.

Called to get the current state of the client

Parameters:

pClient

Reference to the IoT Client

Returns:

ClientState value equal to the current state of the client

Definition at line 62 of file aws_iot_mqtt_client.c.

Get count of Network Disconnects.

Called to get the number of times a network disconnect occurred due to errors

Parameters:

pClient

Reference to the IoT Client

Returns:

uint32_t the disconnect count

Definition at line 357 of file aws_iot_mqtt_client.c.

What is the next available packet Id.

Called to retrieve the next packet id to be used for outgoing packets. Automatically increments the last sent packet id variable

Parameters:

pClient

Reference to the IoT Client

Returns:

next packet id as a 16 bit unsigned integer

Definition at line 284 of file aws_iot_mqtt_client.c.

MQTT Client Initialization Function.

Called to initialize the MQTT Client

Parameters:

pClient	Reference to the IoT Client
pInitParams	Pointer to MQTT connection parameters

Returns:

IoT_Error_t Type defining successful/failed API call

Definition at line 205 of file aws_iot_mqtt_client.c.

Is the MQTT client currently connected?

Called to determine if the MQTT client is currently connected. Used to support logic in the device application around reconnecting and managing offline state.

Parameters:

pClient

Reference to the IoT Client

Returns:

true = connected, false = not currently connected

Definition at line 289 of file aws_iot_mqtt_client.c.

Reset Network Disconnect conter.

Called to reset the Network Disconnect counter to zero

Parameters:

pClient

Reference to the IoT Client

Definition at line 361 of file aws_iot_mqtt_client.c.

Set the connection parameters for the IoT Client.

Called to set the connection parameters for the IoT Client. Used to update the connection parameters provided before the last connect. Won't take effect until the next time connect is called

Parameters:

pClient	Reference to the IoT Client
pNewConnectParams	Reference to the new Connection Parameters structure

Returns:

IoT_Error_t Type defining successful/failed API call

Definition at line 138 of file aws_iot_mqtt_client.c.

Set the IoT Client disconnect handler.

Called to set the IoT Client disconnect handler The disconnect handler is called whenever the client disconnects with error

Parameters:

pClient	Reference to the IoT Client
pConnectHandler	Reference to the new Disconnect Handler
pDisconnectHandlerData	Reference to the data to be passed as argument when disconnect handler is called

Returns:

IoT_Error_t Type defining successful/failed API call

Definition at line 345 of file aws_iot_mqtt_client.c.