Function rcl_node_get_options

• Defined in File node.h

Function Documentation

const rcl_node_options_t *rcl_node_get_options(const rcl_node_t *node)

Return the rcl node options.

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

• node is NULL

• node has not been initialized (the implementation is invalid)

The returned struct is only valid as long as the given rcl_node_t is valid. The values in the struct may change if the options of the rcl_node_t changes, 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:

node – [in] pointer to the node

Returns:

options struct if successful, otherwise NULL