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

Add EventsExecutor release notes #3662

Merged
merged 4 commits into from
May 23, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions source/Releases/Release-Iron-Irwini.rst
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,29 @@ To make this a bit better, there is now a new ``NodeInterfaces`` class that can

There are examples on how to use this in https://github.com/ros2/rclcpp/pull/2041.

Introduction of a new executor type: the Events Executor
""""""""""""""""""""""""""""""""""""""""""""""""""""""""

The ``EventsExecutor`` from iRobot has been merged into the main ``rclcpp`` codebase.
This alternative executor implementation uses event-driven callbacks from the middleware implementations to fire callbacks at the ``rclcpp`` layer.
In addition to the push-based model, the `EventsExecutor` also moves timer management into a separate thread, which can allow for more accurate results and lower overhead, especially with many timers.

The ``EventsExecutor`` has a substantial set of documentation and use-in-practice that make a strong candidate for inclusion the the ``rclcpp`` codebase.
For information about the initial implementation proposal as well as performance benchmarks, see https://discourse.ros.org/t/ros2-middleware-change-proposal/15863.
For more information about the design, see the design PR: https://github.com/ros2/design/pull/305.

Since the API is the same, trying the ``EventsExecutor`` is as straighforward as replacing your current Execotr implmentation (eg. ``SingleThreadedExecutor``):
mjcarroll marked this conversation as resolved.
Show resolved Hide resolved

.. code-block:: C++

#include <rclcpp/experimental/executors/events_executor/events_executor.hpp>
using rclcpp::experimental::executors::EventsExecutor;

EventsExecutor executor;
executor.add_node(node);
executor.spin();


``rclpy``
^^^^^^^^^

Expand Down