search

Azure / azure-iot-sdk-c

A C99 SDK for connecting devices to Microsoft Azure IoT services
https://azure.github.io/azure-iot-sdk-c
Other
585 stars 739 forks source link

IoTHubDeviceClient_LL_SetRetryPolicy and IoTHubDeviceClient_LL_GetRetryPolicy documentation #2538

Closed D-r-P-3-p-p-3-r closed 9 months ago

D-r-P-3-p-p-3-r commented 9 months ago

The IoTHubDeviceClient_LL_SetRetryPolicy and IoTHubDeviceClient_LL_GetRetryPolicy documentation description text seems to be incorrect:

"Sets up the connection status callback to be invoked representing the status of the connection to IOT Hub."

The function sets/gets the retry policy.

It seems to be a copy-and-paste error from IoTHubDeviceClient_LL_SetConnectionStatusCallback.

The documentation of how the different retry policies work is lacking, too. One is just left guessing from the enum values how they work.

ericwolz commented 9 months ago

This retry policies are documented here: https://github.com/Azure/azure-iot-sdk-c/blob/main/doc/connection_and_messaging_reliability.md#connection-retry-policies

ericwolz commented 9 months ago

2542