Skip to content

Commit

Permalink
Notify API breaks
Browse files Browse the repository at this point in the history
API breaks introduced in ros2/rclcpp#1612

Signed-off-by: Mauro Passerino <mpasserino@irobot.com>
  • Loading branch information
mauropasse authored and Mauro Passerino committed Nov 2, 2021
1 parent 53f30f1 commit 4133cee
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions source/Releases/Release-Humble-Hawksbill.rst
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,18 @@ For more details, see `REP 2007 <https://ros.org/reps/rep-2007.html>`_.

For more details, please refer to this `pull request <https://github.com/ros2/rclcpp/pull/1723>`_.

``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 an 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 <https://github.com/ros2/rclcpp/pull/1612>`__ for more details.

``get_notify_guard_condition`` method return type from ``NodeBaseInterface`` class changed from ``rcl_guard_condition_t *`` to ``rclcpp::GuardCondition &``
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
Now ``rclcpp`` uses the ``GuardCondition`` class wrapper around ``rcl_guard_condition_t``, so ``get_notify_guard_condition`` returns now 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 <https://github.com/ros2/rclcpp/pull/1612>`__ for more details.

ros2cli
^^^^^^^

Expand Down

0 comments on commit 4133cee

Please sign in to comment.