[20706] Make reader get_first_untaken_info() coherent with read()/take() (backport #4696) #4706
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR corrects the behavior of
get_first_untaken_info()
so that it retrieves the first valid cache change (checking whether the change is in the future or not), instead of just returning the first one in the instance (sorted by sourcetimestamp).In the scenario of having multiple reliable writers and one reader with history size > 1 in the same topic, it can happen that
get_first_untaken_info()
returnsOK
(as it is not currently checking whether the change is in the future) buttake()
returnsNO_DATA
because the change is in the future.In addition, a brief doxygen documentation is added to be aware that the method is meant to be followed by a
read()
ortake()
since it does not modify the status condition of the entity.@Mergifyio backport 2.13.x 2.10.x 2.6.x
Fixes ros2/rmw_fastrtps#749
Contributor Checklist
Commit messages follow the project guidelines.
The code follows the style guidelines of this project.
Tests that thoroughly check the new feature have been added/Regression tests checking the bug and its fix have been added; the added tests pass locally
Any new/modified methods have been properly documented using Doxygen.
Any new configuration API has an equivalent XML API (with the corresponding XSD extension)
Changes are ABI compatible.
Changes are API compatible.
N/A New feature has been added to the
versions.md
file (if applicable).N/A New feature has been documented/Current behavior is correctly described in the documentation.
Applicable backports have been included in the description.
Reviewer Checklist
This is an automatic backport of pull request #4696 done by [Mergify](https://mergify.com).