Function rcl_timer_get_period

• Defined in File timer.h

Function Documentation

rcl_ret_t rcl_timer_get_period(const rcl_timer_t *timer, int64_t *period)

Retrieve the period of the timer.

This function retrieves the period and copies it into the given variable.

The period argument must be a pointer to an already allocated int64_t.

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 which is being queried

• period – [out] the int64_t in which the period is stored

Returns:

RCL_RET_OK if the period was retrieved successfully, 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_ERROR an unspecified error occur.