Skip to content

Commit

Permalink
Update the description of wait_for_all_acked
Browse files Browse the repository at this point in the history
Signed-off-by: Barry Xu <barry.xu@sony.com>
  • Loading branch information
Barry-Xu-2018 committed Aug 23, 2021
1 parent a772350 commit 8730ebd
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions rclcpp/include/rclcpp/publisher_base.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,9 @@ class PublisherBase : public std::enable_shared_from_this<PublisherBase>
* If the timeout is greater than 0 then this function will return after that period of time has
* elapsed (return false) or all published message data were acknowledged (return true).
*
* This function only waits for acknowledgments if the publisher's QOS profile is RELIABLE.
* Otherwise this function will immediately return `true`.
*
* \param[in] timeout the duration to wait for all published message data were acknowledged.
* \return `true` if all published message data were acknowledged before timeout, otherwise
* `false`.
Expand Down

0 comments on commit 8730ebd

Please sign in to comment.