Function rcl_action_server_get_action_name

Defined in File action_server.h

Function Documentation

const char *rcl_action_server_get_action_name(const rcl_action_server_t *action_server)

Get the action name for an action server.

This function returns the action server’s internal topic name string. 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 string is only valid as long as the action server is valid. The value of the string may change if the topic name changes, and therefore copying the string 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] pointer to the action server
Returns:: name string if successful, or
Returns:: NULL otherwise.