Function rcl_action_client_wait_set_get_entities_ready

Function Documentation

rcl_ret_t rcl_action_client_wait_set_get_entities_ready(const rcl_wait_set_t *wait_set, const rcl_action_client_t *action_client, bool *is_feedback_ready, bool *is_status_ready, bool *is_goal_response_ready, bool *is_cancel_response_ready, bool *is_result_response_ready)

Get the wait set entities that are ready for a rcl_action_client_t.

The caller can use this function to determine the relevant action client functions to call: rcl_action_take_feedback(), rcl_action_take_status(), rcl_action_take_goal_response(), rcl_action_take_cancel_response(), or rcl_action_take_result_response().

Attribute

Adherence

Allocates Memory

No

Thread-Safe

No

Uses Atomics

No

Lock-Free

Yes

Parameters:

  • wait_set – [in] struct where action server services are to be stored

  • action_client – [in] an action client to query

  • is_feedback_ready – [out] true if there is a feedback message ready to take, false otherwise

  • is_status_ready – [out] true if there is a status message ready to take, false otherwise

  • is_goal_response_ready – [out] true if there is a goal response message ready to take, false otherwise

  • is_cancel_response_ready – [out] true if there is a cancel response message ready to take, false otherwise

  • is_result_response_ready – [out] true if there is a result response message ready to take, false otherwise

Returns:

RCL_RET_OK if call is successful, or

Returns:

RCL_RET_WAIT_SET_INVALID if the wait set is invalid, or

Returns:

RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or

Returns:

RCL_RET_ACTION_CLIENT_INVALID if the action client is invalid, or

Returns:

RCL_RET_ERROR if an unspecified error occurs.