Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Porting guide documentation error #36

Closed
tim-nordell-nimbelink opened this issue Jul 28, 2016 · 3 comments
Closed

Porting guide documentation error #36

tim-nordell-nimbelink opened this issue Jul 28, 2016 · 3 comments

Comments

@tim-nordell-nimbelink
Copy link

For https://github.com/aws/aws-iot-device-sdk-embedded-C/blob/master/PortingGuide.md, it states:

IoT_Error_t iot_tls_is_connected(Network *pNetwork); Check if the TLS layer is still connected

However, the documentation inside network_interface.h states:

IoT_Error_t (*isConnected)(Network *);    ///< Function pointer pointing to the network function to check if physical layer is connected

The usage is against the latter definition (e.g. your Ethernet cord is still plugged in or not) versus the former definition (e.g. your TLS layer got disconnected) in the only callee from within _aws_iot_mqtt_handle_reconnect(...). It will not attempt a reconnect unless this function returns NETWORK_PHYSICAL_LAYER_CONNECTED which indicates that it's not checking if the TLS layer is still connected.

@chaurah
Copy link
Contributor

chaurah commented Jul 29, 2016

Hi Tim,
Thank you for pointing this out. The intention of the function, as you correctly state, is to determine if the Physical layer is connected, not the TLS layer. We should make that clearer and probably provide a separate API for checking the state of the TLS layer. I will add a fix for this to the next release. If you have any further thoughts on how we can handle this better please do let us know.

Rahul

@chaurah
Copy link
Contributor

chaurah commented Sep 19, 2016

Fixed in v2.1.1 of the SDK. Closing.

@tim-nordell-nimbelink
Copy link
Author

tim-nordell-nimbelink commented Sep 20, 2016

Hi!

While the newest changeset makes iot_tls_is_connect(...) consistent with isConnected(...), the changeset should have modified the documentation around iot_tls_is_Connect(...) and not isConnected(...).

(I cannot reopen this issue.)

  • Tim

tgsong pushed a commit to tgsong/aws-iot-device-sdk-embedded-C that referenced this issue Nov 13, 2020
Changing OTA demo project structure
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants