Function rcl_action_client_wait_set_get_num_entities

Function Documentation

rcl_ret_t rcl_action_client_wait_set_get_num_entities(const rcl_action_client_t *action_client, size_t *num_subscriptions, size_t *num_guard_conditions, size_t *num_timers, size_t *num_clients, size_t *num_services)

Get the number of wait set entities associated with a rcl_action_client_t.

Returns the number of entities that are added to the wait set if rcl_action_wait_set_add_action_client() is called.

Attribute

Adherence

Allocates Memory

No

Thread-Safe

Yes

Uses Atomics

No

Lock-Free

Yes

Parameters:

  • action_client – [in] an action client to query

  • num_subscriptions – [out] the number of subscriptions added when the action client is added to the wait set

  • num_guard_conditions – [out] the number of guard conditions added when the action client is added to the wait set

  • num_timers – [out] the number of timers added when the action client is added to the wait set

  • num_clients – [out] the number of clients added when the action client is added to the wait set

  • num_services – [out] the number of services added when the action client is added to the wait set

Returns:

RCL_RET_OK if call is successful, 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.