Function rcl_timer_get_callback

Function Documentation

rcl_timer_callback_t rcl_timer_get_callback(const rcl_timer_t *timer)

Return the current timer callback.

This function can fail, and therefore return NULL, if:

  • timer is NULL

  • timer has not been initialized (the implementation is invalid)

Attribute

Adherence

Allocates Memory

No

Thread-Safe

Yes

Uses Atomics

Yes

Lock-Free

Yes [1]

[1] if returns true for

Parameters:

timer – [in] handle to the timer from the callback should be returned

Returns:

function pointer to the callback, or NULL if an error occurred