[#390] waitset

[elfenpiff]

Notes for Reviewer

• Implements a high-level WaitSet by utilizing the iceoryx2_cal::reactor
  • WaitSet is end-user API
  • reactor is a iceoryx2 concept that can be implemented by select, epoll or io_uring multiplexing
• Provides a first example demonstrating the waitset in Rust - C & C++ binding will follow in separate PR
• The NodeEvent was renamed into WaitEvent to signal to the user that Node::wait() will utilize an internal WaitSet (in the future)

Pre-Review Checklist for the PR Author

1. Add sensible notes for the reviewer
2. PR title is short, expressive and meaningful
3. Relevant issues are linked in the References section
4. Every source code file has a copyright header with SPDX-License-Identifier: Apache-2.0 OR MIT
5. Branch follows the naming format (iox2-123-introduce-posix-ipc-example)
6. Commits messages are according to this guideline
   • Commit messages have the issue ID ([#123] Add posix ipc example)
   • Commit author matches Eclipse Contributor Agreement (and ECA is signed)
7. Tests follow the best practice for testing
8. Changelog updated in the unreleased section including API breaking changes
9. Assign PR to reviewer
10. 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

1. All open points are addressed and tracked via issues

References

Relates to #390

[elBoberido]

I need a break before reviewing the waitset test. Everything else is reviewed. Looks good.

[elBoberido]

Intermediate result

[codecov]

Codecov Report

Attention: Patch coverage is 80.77601% with 109 lines in your changes missing coverage. Please review.

Project coverage is 79.00%. Comparing base (6f05b7b) to head (5904a48).
Report is 41 commits behind head on main.

Files with missing lines	Patch %	Lines
iceoryx2/src/port/waitset.rs	78.98%	66 Missing ⚠️
iceoryx2-bb/posix/src/deadline_queue.rs	89.65%	15 Missing ⚠️
iceoryx2-cal/src/reactor/posix_select.rs	75.00%	13 Missing ⚠️
iceoryx2/src/node/mod.rs	0.00%	12 Missing ⚠️
iceoryx2-bb/posix/src/file_descriptor_set.rs	91.66%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #424      +/-   ##
==========================================
+ Coverage   78.97%   79.00%   +0.03%     
==========================================
  Files         195      196       +1     
  Lines       22836    23251     +415     
==========================================
+ Hits        18034    18369     +335     
- Misses       4802     4882      +80     

Files with missing lines	Coverage Δ
iceoryx2-bb/posix/src/clock.rs	85.71% <100.00%> (+0.31%)	⬆️
iceoryx2-bb/posix/src/udp_socket.rs	73.89% <100.00%> (ø)
iceoryx2/src/port/listener.rs	91.42% <100.00%> (+0.25%)	⬆️
iceoryx2/src/port/mod.rs	0.00% <ø> (ø)
iceoryx2/src/service/ipc.rs	100.00% <ø> (ø)
iceoryx2/src/service/local.rs	100.00% <ø> (ø)
iceoryx2/src/service/mod.rs	78.34% <ø> (ø)
iceoryx2-bb/posix/src/file_descriptor_set.rs	91.92% <91.66%> (+1.14%)	⬆️
iceoryx2/src/node/mod.rs	68.83% <0.00%> (-2.17%)	⬇️
iceoryx2-cal/src/reactor/posix_select.rs	81.55% <75.00%> (+2.98%)	⬆️
... and 2 more

... and 5 files with indirect coverage changes

[elBoberido]

It seems the only thing left complaining about is naming :)