Skip to content

Commit

Permalink
add to docs a note about parallel processing support of spin_until_fu…
Browse files Browse the repository at this point in the history
…ture_complete

Signed-off-by: Matthias Holoch <[email protected]>
  • Loading branch information
Cakem1x committed Apr 5, 2024
1 parent f7d44d9 commit d91e9f4
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions rclcpp/include/rclcpp/executor.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -347,6 +347,7 @@ class Executor

/// Spin (blocking) until the future is complete, it times out waiting, or rclcpp is interrupted.
/**
* Handles one work item after the other, hence, it does not support parallel processing.
* \param[in] future The future to wait on. If this function returns SUCCESS, the future can be
* accessed without blocking (though it may still throw an exception).
* \param[in] timeout Optional timeout parameter, which gets passed to Executor::spin_node_once.
Expand Down

0 comments on commit d91e9f4

Please sign in to comment.