Function rcl_guard_condition_fini

• Defined in File guard_condition.h

Function Documentation

rcl_ret_t rcl_guard_condition_fini(rcl_guard_condition_t *guard_condition)

Finalize a rcl_guard_condition_t.

After calling, calls to rcl_trigger_guard_condition() will fail when using this guard condition.

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

[1] specifically not thread-safe with rcl_trigger_guard_condition()

Parameters:

guard_condition – [inout] handle to the guard_condition to be finalized

Returns:

RCL_RET_OK if guard_condition was finalized successfully, or

Returns:

RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or

Returns:

RCL_RET_ERROR if an unspecified error occurs.