Skip to content

Conversation

FerdinandSpitzschnueffler
Copy link
Contributor

@FerdinandSpitzschnueffler FerdinandSpitzschnueffler commented Oct 15, 2025

Notes for Reviewer

See title. The Rust example was adapted for cross-language communication.

Pre-Review Checklist for the PR Author

  • Add sensible notes for the reviewer
  • PR title is short, expressive and meaningful
  • Consider switching the PR to a draft (Convert to draft)
    • as draft PR, the CI will be skipped for pushes
  • Relevant issues are linked in the References section
  • Every source code file has a copyright header with SPDX-License-Identifier: Apache-2.0 OR MIT
  • Branch follows the naming format (iox2-123-introduce-posix-ipc-example)
  • Commits messages are according to this guideline
  • Tests follow the best practice for testing
  • [ ] Changelog updated in the unreleased section including API breaking changes
  • Assign PR to reviewer
  • All checks have passed (except task-list-completed)

Checklist for the PR Reviewer

  • Commits are properly organized and messages are according to the guideline
  • Unit tests have been written for new behavior
  • Public API is documented
  • PR title describes the changes

Post-review Checklist for the PR Author

  • All open points are addressed and tracked via issues

References

Relates to #817

Copy link

codecov bot commented Oct 15, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.93%. Comparing base (4ac0efa) to head (661e493).

Additional details and impacted files

Impacted file tree graph

@@           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           
Flag Coverage Δ
Rust 77.93% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.
see 4 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

> **types in the `iceoryx2-bb-container` library are cross-language**
> **compatible!**
This example illustrates the blackboard messaging pattern. A writer updates the
Copy link
Contributor

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) {
Copy link
Contributor

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 {
Copy link
Contributor

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
Copy link
Contributor

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

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

Successfully merging this pull request may close these issues.

2 participants