Function rcl_timer_get_guard_condition

Function Documentation

rcl_guard_condition_t *rcl_timer_get_guard_condition(const rcl_timer_t *timer)

Retrieve a guard condition used by the timer to wake the waitset when using ROSTime.

Attribute

Adherence

Allocates Memory

No

Thread-Safe

No

Uses Atomics

No

Lock-Free

Yes

Parameters:

timer[in] the timer to be queried

Returns:

NULL if the timer is invalid or does not have a guard condition, or

Returns:

a guard condition pointer.