Function rcl_timer_get_allocator

Function Documentation

const rcl_allocator_t *rcl_timer_get_allocator(const rcl_timer_t *timer)

Return the allocator for the timer.

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

  • timer is NULL

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

The returned pointer is only valid as long as the timer object is valid.

Attribute

Adherence

Allocates Memory

No

Thread-Safe

Yes

Uses Atomics

No

Lock-Free

Yes

Parameters:

timer[inout] handle to the timer object

Returns:

pointer to the allocator, or NULL if an error occurred