Function rcl_timer_get_next_call_time

Function Documentation

rcl_ret_t rcl_timer_get_next_call_time(const rcl_timer_t *timer, int64_t *next_call_time)

Retrieve the time when the next call to rcl_timer_call() shall occur.

Attribute

Adherence

Allocates Memory

No

Thread-Safe

Yes

Uses Atomics

Yes

Lock-Free

Yes [1]

[1] if returns true for

Parameters:

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

  • next_call_time – [out] the output variable for the result

Returns:

RCL_RET_OK if the timer until next call was successfully calculated, or

Returns:

RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or

Returns:

RCL_RET_TIMER_INVALID if the timer->impl is invalid, or

Returns:

RCL_RET_TIMER_CANCELED if the timer is canceled, or

Returns:

RCL_RET_ERROR an unspecified error occur.