-
Notifications
You must be signed in to change notification settings - Fork 92
[#817] C/C++ blackboard examples #1112
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
base: main
Are you sure you want to change the base?
[#817] C/C++ blackboard examples #1112
Conversation
Improve cleanup, add readme, add e2e test, bazel
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1112 +/- ##
=======================================
Coverage 77.93% 77.93%
=======================================
Files 358 358
Lines 38404 38404
Branches 282 282
=======================================
Hits 29929 29929
Misses 7864 7864
Partials 611 611
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
| > **types in the `iceoryx2-bb-container` library are cross-language** | ||
| > **compatible!** | ||
| This example illustrates the blackboard messaging pattern. A writer updates the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you please describe the blackboard messaging pattern in a view sentences. It shall contain:
- Is a key value store/repository in shared memory
- Can be used to share a global config or state
Can you then update the description of the C++ and Rust example as well with this short introduction.
| uint16_t z; | ||
| }; | ||
|
|
||
| bool key_cmp(const void* lhs, const void* rhs) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you please add a short comment on why the user has to do this.
| std::int64_t y; // NOLINT | ||
| std::uint16_t z; // NOLINT | ||
|
|
||
| auto operator==(const BlackboardKey& rhs) const -> bool { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we add here a one liner why this is required
| > **types in the `iceoryx2-bb-container` library are cross-language** | ||
| > **compatible!** | ||
| This example illustrates the blackboard messaging pattern. A writer updates the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we should also add here the requirement for the blackboard keys, beside the shm requirements it must implement operator==
We should also add this to the Rust and C readme
Notes for Reviewer
See title. The Rust example was adapted for cross-language communication.
Pre-Review Checklist for the PR Author
Convert to draft)SPDX-License-Identifier: Apache-2.0 OR MITiox2-123-introduce-posix-ipc-example)[#123] Add posix ipc example)[ ] Changelog updated in the unreleased section including API breaking changestask-list-completed)Checklist for the PR Reviewer
Post-review Checklist for the PR Author
References
Relates to #817