Function rcl_action_server_get_options

Defined in File action_server.h

Function Documentation

const rcl_action_server_options_t *rcl_action_server_get_options(const rcl_action_server_t *action_server)

Return the rcl_action_server_options_t for an action server.

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

action server is NULL
action server is invalid (e.g. never called init or called fini)

The returned struct is only valid as long as the action server is valid. The values in the struct may change if the action server’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_server – [in] handle to the action server
Returns:: options struct if successful, or
Returns:: NULL otherwise.