Function rclc_timer_init_default

Function Documentation

rcl_ret_t rclc_timer_init_default(rcl_timer_t *timer, rclc_support_t *support, const uint64_t timeout_ns, const rcl_timer_callback_t callback)

Creates an rcl timer.

  • Attribute

    Adherence

    Allocates Memory

    Yes (in RCL)

    Thread-Safe

    No

    Uses Atomics

    No

    Lock-Free

    Yes

Parameters:

  • timer – [inout] a zero-initialized rcl_timer_t

  • support – [in] the rclc_support_t object

  • timeout_ns – [in] the time out in nanoseconds of the timer

  • callback – [in] the callback of the timer

Returns:

RCL_RET_OK if successful

Returns:

RCL_ERROR (or other error code) if an error occurred