Function rcl_timer_set_on_reset_callback

• Defined in File timer.h

Function Documentation

rcl_ret_t rcl_timer_set_on_reset_callback(const rcl_timer_t *timer, rcl_event_callback_t on_reset_callback, const void *user_data)

Set the on reset callback function for the timer.

This API sets the callback function to be called whenever the timer is reset. If the timer has already been reset, the callback will be called.

Attribute	Adherence
Allocates Memory	No
Thread-Safe	No
Uses Atomics	No
Lock-Free	No

Parameters:

• timer – [in] The handle to the timer on which to set the callback

• on_reset_callback – [in] The callback to be called when timer is reset

• user_data – [in] Given to the callback when called later, may be NULL

Returns:

RCL_RET_OK if successful, or

Returns:

RCL_RET_INVALID_ARGUMENT if timer is NULL