[Documentation] Correct comments around ScheduleLambda to indicate it is thread safe #26538
Comments
tcarmelveilleux
added a commit
to tcarmelveilleux/connectedhomeip
that referenced
this issue
Jun 18, 2024
Problem: - SystemLayer::ScheduleLambda is critical to allow correct context updates to data, but it was claimed it had to be executed in Matter context already, which is the opposite of the point of the method. Fixes project-chip#26538 This PR: - Improves the documentation of several methods in SystemLayer.h - Makes ScheduleLambdaBridge private (not called elsewhere) - Adds a static assert to avoid arguments on the lambda Testing done: - All unit tests still pass
diogopintodsr
pushed a commit
to diogopintodsr/connectedhomeip
that referenced
this issue
Jun 20, 2024
* Improve documentation of ScheduleLambda Problem: - SystemLayer::ScheduleLambda is critical to allow correct context updates to data, but it was claimed it had to be executed in Matter context already, which is the opposite of the point of the method. Fixes project-chip#26538 This PR: - Improves the documentation of several methods in SystemLayer.h - Makes ScheduleLambdaBridge private (not called elsewhere) - Adds a static assert to avoid arguments on the lambda Testing done: - All unit tests still pass * Restyled by clang-format --------- Co-authored-by: Restyled.io <commits@restyled.io>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Documentation issues
In SystemLayer.h, documentation around ScheduleLambda declaration indicates that it is not thread safe and it should be called only from CHIP context. Yet, our analysis (attached) indicates there are no such issues with ScheduleLambda. To be further checked and if it confirms, to update documentation.
Platform
core (please add to version below)
Anything else?
ScheduleLambda_Audit.pdf
The text was updated successfully, but these errors were encountered: