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

Iox #14 adjust untyped user header api #665

Conversation

elBoberido
Copy link
Member

@elBoberido elBoberido commented Apr 1, 2021

Pre-Review Checklist for the PR Author

  1. Code follows the coding style of CONTRIBUTING.md
  2. Tests follow the best practice for testing
  3. Branch follows the naming format (iox-#123-this-is-a-branch)
  4. Commits messages are according to this guideline
    • Commit messages have the issue ID (iox-#123 commit text)
    • Commit messages are signed (git commit -s)
    • Commit author matches Eclipse Contributor Agreement (and ECA is signed)
  5. Update the PR title
    • Follow the same conventions as for commit messages
    • Link to the relevant issue
  6. Relevant issues are linked
  7. Add sensible notes for the reviewer
  8. All checks have passed (except task-list-completed)
  9. Assign PR to reviewer

Notes for Reviewer

This PR refactors the user-header untyped API to be able to implement a gateway, which needs to set the user-header on a per sample base.

Additionally, the typed publisher/subscriber get an alias like the untyped ones in order to prevent the user from specifying a BasePublisher/BaseSubscriber.

Lastly, ChunkHeader::userHeader is now untyped like ChunkHeader::userPayload. Later on we can introduce ChunkHeader::userHeaderTyped and ChunkHeader::userPayloadTyped if necessary

Checklist for the PR Reviewer

  • Commits are properly organized and messages are according to the guideline
  • Code according to our coding style and naming conventions
  • Unit tests have been written for new behavior
  • Public API changes are documented via doxygen
  • Copyright owner are updated in the changed files
  • PR title describes the changes

Post-review Checklist for the PR Author

  1. All open points are addressed and tracked via issues

References

@elBoberido elBoberido force-pushed the iox-#14-adjust-untyped-user-header-API branch from 571dacf to 6968f8c Compare April 1, 2021 14:54
@mossmaurice mossmaurice added the refactoring Refactor code without adding features label Apr 1, 2021
elfenpiff
elfenpiff previously approved these changes Apr 1, 2021
Signed-off-by: Mathias Kraus <[email protected]>
@codecov
Copy link

codecov bot commented Apr 1, 2021

Codecov Report

Merging #665 (6b9f226) into master (a7bc3a0) will increase coverage by 0.01%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #665      +/-   ##
==========================================
+ Coverage   74.37%   74.39%   +0.01%     
==========================================
  Files         319      318       -1     
  Lines       11207    11204       -3     
  Branches     1963     1963              
==========================================
  Hits         8335     8335              
+ Misses       2100     2097       -3     
  Partials      772      772              
Flag Coverage Δ
unittests 74.34% <100.00%> (+0.01%) ⬆️
unittests_timing 31.22% <0.00%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
...ude/iceoryx_binding_c/internal/cpp2c_publisher.hpp 100.00% <ø> (ø)
iceoryx_posh/include/iceoryx_posh/popo/sample.hpp 57.14% <ø> (ø)
...sh/include/iceoryx_posh/popo/untyped_publisher.hpp 100.00% <ø> (ø)
iceoryx_binding_c/source/c_chunk.cpp 100.00% <100.00%> (ø)
iceoryx_binding_c/source/c_publisher.cpp 85.29% <100.00%> (-0.63%) ⬇️
...h/include/iceoryx_posh/internal/popo/publisher.inl 100.00% <100.00%> (ø)
...posh/include/iceoryx_posh/internal/popo/sample.inl 82.85% <100.00%> (ø)
.../include/iceoryx_posh/internal/popo/subscriber.inl 80.00% <100.00%> (ø)
...e/iceoryx_posh/internal/popo/untyped_publisher.inl 100.00% <100.00%> (ø)
...eoryx_posh/include/iceoryx_posh/popo/publisher.hpp 100.00% <100.00%> (ø)
... and 4 more

@elBoberido elBoberido merged commit 79db27b into eclipse-iceoryx:master Apr 1, 2021
@elBoberido elBoberido deleted the iox-#14-adjust-untyped-user-header-API branch April 1, 2021 15:52
marthtz pushed a commit to boschglobal/iceoryx that referenced this pull request May 12, 2021
…yped-user-header-API

Iox eclipse-iceoryx#14 adjust untyped user header api
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactoring Refactor code without adding features
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Reserved chunkinfo user payload header
4 participants