Function rcl_action_client_configure_feedback_subscription_filter_remove_goal_id

• Defined in File action_client.h

Function Documentation

rcl_ret_t rcl_action_client_configure_feedback_subscription_filter_remove_goal_id(const rcl_action_client_t *action_client, const uint8_t *goal_id_array, size_t array_size)

Configure feedback subscription content filter to remove one goal ID.

If goal ID doesn’t exist in feedback subscription content filter, return RCL_RET_OK.

If rmw middleware doesn’t support content filtering feature, return RCL_RET_UNSUPPORTED.

Attribute	Adherence
Allocates Memory	Yes
Thread-Safe	No
Uses Atomics	Maybe [1]
Lock-Free	Maybe [1]

[1] rmw implementation defined

Parameters:

• action_client – [in] action client whose feedback subscription content filter will be configured

• goal_id – [in] goal id represented as a uint8_t array

• array_size – [in] size of the goal_id array

Returns:

#RCL_RET_OK if the call was successful, or

Returns:

#RCL_RET_ACTION_CLIENT_INVALID if the action client is invalid, or

Returns:

#RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or

Returns:

#RCL_RET_BAD_ALLOC if allocating memory failed, or

Returns:

#RCL_RET_ERROR if calling other rcl functions internally does not return RCL_RET_OK, or

Returns:

#RCL_RET_UNSUPPORTED if the middleware doesn’t support content filtering