Skip to content

Commit 633c066

Browse files
authored
add notice about API break in rmw (#345)
Signed-off-by: William Woodall <[email protected]>
1 parent 08ad23d commit 633c066

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

source/Releases/Release-Eloquent-Elusor.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,25 @@ Please see the original pr for more detail and comment there if this causes issu
7575

7676
`https://github.com/ros2/rclcpp/pull/867 <https://github.com/ros2/rclcpp/pull/867>`_
7777

78+
rmw
79+
^^^
80+
81+
API Break Due to Addition of Publisher and Subscription Options
82+
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
83+
84+
The ``rmw_create_publisher()`` method had a new argument added of type ``const rmw_publisher_options_t *``.
85+
This new structure holds options (beyond the typesupport, topic name, and QoS) for new publishers.
86+
87+
The ``rmw_create_subscription()`` method had one argument removed, ``bool ignore_local_publications``, and replaced by the new options of type ``const rmw_subscription_options_t *``.
88+
The ``ignore_local_publications`` option was moved into the new ``rmw_subscription_options_t`` type.
89+
90+
In both cases the new argument, which are pointers, may never be null, and so the rmw implementations should check to make sure the options are not null.
91+
Additionally, the options should be copied into the corresponding rmw structure.
92+
93+
See this pull request, and the associated pull requests for more details:
94+
95+
`https://github.com/ros2/rmw/pull/187 <https://github.com/ros2/rmw/pull/187>`_
96+
7897
Timeline before the release
7998
---------------------------
8099

0 commit comments

Comments
 (0)