Function rcl_system_clock_fini

• Defined in File time.h

Function Documentation

rcl_ret_t rcl_system_clock_fini(rcl_clock_t *clock)

Finalize a clock as a RCL_SYSTEM_TIME time source.

Finalize the clock as a RCL_SYSTEM_TIME time source.

This will deallocate all necessary internal structures, and clean up any variables. It is specifically setting up a system time source. It is expected to be paired with the init fuction.

This function is not thread-safe with any function operating on the same clock object.

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

[1] Function is reentrant, but concurrent calls on the same object are not safe. Thread-safety is also affected by that of the object associated with the object.

Parameters:

clock – [in] the handle to the clock which is being initialized.

Returns:

RCL_RET_OK if the time source was successfully finalized, or

Returns:

RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or

Returns:

RCL_RET_ERROR an unspecified error occur.