Skip to content

Commit cfaec5b

Browse files
committed
Improve documentation for action client feedback message optimization
Signed-off-by: Barry Xu <barry.xu@sony.com>
1 parent ce547eb commit cfaec5b

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

rclcpp_action/include/rclcpp_action/client.hpp

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,13 @@ class Client : public ClientBase
111111
* This constructs an action client, but it will not work until it has been added to a node.
112112
* Use `rclcpp_action::create_client()` to both construct and add to a node.
113113
*
114+
* When multiple action clients connect to the same action server, the subscription for receiving
115+
* feedback messages inside each action client will first receive all feedback messages, and then
116+
* determine which feedback belongs to itself based on goal ID. When
117+
* enable_feedback_msg_optimization is set to true, the content filter is used to configure
118+
* the goal ID for the subscription, which helps avoid the reception of irrelevant feedback
119+
* messages internally for each action client.
120+
*
114121
* If enable_feedback_msg_optimization is set to true, an action client can handle up to 6 goals
115122
* simultaneously. If the number of goals exceeds the limit, optimization is automatically
116123
* disabled.

0 commit comments

Comments
 (0)