Function rcl_timer_get_callback_data

• Defined in File timer.h

Function Documentation

uintptr_t rcl_timer_get_callback_data(const rcl_timer_t *timer)

Return the current timer callback data.

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 data that should be returned

Returns:

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