Function rcl_guard_condition_get_options

• Defined in File guard_condition.h

Function Documentation

const rcl_guard_condition_options_t *rcl_guard_condition_get_options(const rcl_guard_condition_t *guard_condition)

Return the guard condition options.

Returned is a pointer to the internally held rcl_guard_condition_options_t. This function can fail, and therefore return NULL, if the:

• guard_condition is NULL

• guard_condition is invalid (never called init, called fini, or invalid node)

The returned pointer is made invalid if the guard condition is finalized.

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

Parameters:

guard_condition – [in] pointer to the rcl guard_condition

Returns:

rcl guard condition options if successful, otherwise NULL