From ec60c5b99254ef74ca23728f0a87a5b5e48569be Mon Sep 17 00:00:00 2001 From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com> Date: Tue, 30 Nov 2021 14:41:59 -0500 Subject: [PATCH] Notify API breaks (#2086) (#2151) * Notify API breaks API breaks introduced in https://github.com/ros2/rclcpp/pull/1612 Signed-off-by: Mauro Passerino * Address PR suggestions Signed-off-by: Mauro Passerino Co-authored-by: Mauro Passerino (cherry picked from commit 9b74059068a49d60ab51bcd7716627d2a6697adb) Co-authored-by: mauropasse --- source/Releases/Release-Humble-Hawksbill.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/source/Releases/Release-Humble-Hawksbill.rst b/source/Releases/Release-Humble-Hawksbill.rst index 97e0725c75..fc1edcd477 100644 --- a/source/Releases/Release-Humble-Hawksbill.rst +++ b/source/Releases/Release-Humble-Hawksbill.rst @@ -226,6 +226,22 @@ For more details, see `REP 2007 `_. For more details, please refer to this `pull request `_. +``add_to_wait_set`` method from ``Waitable`` class changes its return type from ``bool`` to ``void`` +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +Before, classes derived from ``Waitable`` overriding ``add_to_wait_set`` were returning false when failing to add elements to the wait set, so the caller had to check this return value and throw or handle the error. +This error handling should now be done directly on ``add_to_wait_set`` method, throwing if necessary. +It is not required to return anything if no errors happened. +Thus, this is a breaking change for downstream uses of ``Waitable``. + +See `ros2/rclcpp#1612 `__ for more details. + +``get_notify_guard_condition`` method return type from ``NodeBaseInterface`` class changed +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +Now ``rclcpp`` uses the ``GuardCondition`` class wrapper around ``rcl_guard_condition_t``, so ``get_notify_guard_condition`` returns a reference to the node's ``rclcpp::GuardCondition``. +Thus, this is a breaking change for downstream uses of ``NodeBaseInterface`` and ``NodeBase``. + +See `ros2/rclcpp#1612 `__ for more details. + ros2cli ^^^^^^^