Function rcl_get_node_names_with_enclaves

Function Documentation

rcl_ret_t rcl_get_node_names_with_enclaves(const rcl_node_t *node, rcl_allocator_t allocator, rcutils_string_array_t *node_names, rcutils_string_array_t *node_namespaces, rcutils_string_array_t *enclaves)

Return a list of node names and their associated namespaces and enclaves in the ROS graph.

An rcl_get_node_names() equivalent, but including in its output the enclave name the node is using.

Attribute

Adherence

Allocates Memory

Yes

Thread-Safe

No

Uses Atomics

No

Lock-Free

Maybe [1]

[1] RMW implementation in use may need to protect the data structure with a lock

Parameters:

  • node – [in] the handle to the node being used to query the ROS graph

  • allocator – [in] used to control allocation and deallocation of names

  • node_names – [out] struct storing discovered node names

  • node_namespaces – [out] struct storing discovered node namespaces

  • enclaves – [out] struct storing discovered node enclaves

Returns:

RCL_RET_OK if the query was successful, or

Returns:

RCL_RET_BAD_ALLOC if an error occurred while allocating memory, or

Returns:

RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or

Returns:

RCL_RET_ERROR if an unspecified error occurs.