Function rcl_timer_clock

• Defined in File timer.h

Function Documentation

rcl_ret_t rcl_timer_clock(const rcl_timer_t *timer, rcl_clock_t **clock)

Retrieve the clock of the timer.

This function retrieves the clock pointer and copies it into the given variable.

The clock argument must be a pointer to an already allocated rcl_clock_t *.

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

Parameters:

• timer – [in] the handle to the timer which is being queried

• clock – [out] the rcl_clock_t * in which the clock is stored

Returns:

RCL_RET_OK if the clock was retrieved successfully, or

Returns:

RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or

Returns:

RCL_RET_TIMER_INVALID if the timer is invalid.