Function rcl_action_client_get_options

• Defined in File action_client.h

Function Documentation

const rcl_action_client_options_t *rcl_action_client_get_options(const rcl_action_client_t *action_client)

Return the options for a rcl_action_client_t.

This function returns the action client’s internal options struct. This function can fail, and therefore return NULL, if the:

• action client is NULL

• action client is invalid (never called init, called fini, or invalid)

The returned struct is only valid as long as the action client is valid. The values in the struct may change if the action client’s options change, and therefore copying the struct is recommended if this is a concern.

Attribute	Adherence
Allocates Memory	No
Thread-Safe	No
Uses Atomics	No
Lock-Free	Yes

Parameters:

action_client – [in] pointer to the action client

Returns:

options struct if successful, otherwise NULL