Function rcl_timer_fini

• Defined in File timer.h

Function Documentation

rcl_ret_t rcl_timer_fini(rcl_timer_t *timer)

Finalize a timer.

This function will deallocate any memory and make the timer invalid.

A timer that is already invalid (zero initialized) or NULL will not fail.

This function is not thread-safe with any rcl_timer_* functions used on the same timer object.

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

[1] if returns true for

[2] if returns true for

[3] if returns true for

Parameters:

timer – [inout] the handle to the timer to be finalized.

Returns:

RCL_RET_OK if the timer was finalized successfully, or

Returns:

RCL_RET_ERROR an unspecified error occur.