Function rcl_init_options_get_allocator

Function Documentation

const rcl_allocator_t *rcl_init_options_get_allocator(const rcl_init_options_t *init_options)

Return the allocator stored in the init_options.

This function can fail and return NULL if:

  • init_options is NULL

  • init_options is invalid, e.g. init_options->impl is NULL

If NULL is returned an error message will have been set.

Attribute

Adherence

Allocates Memory

No

Thread-Safe

Yes

Uses Atomics

No

Lock-Free

Yes

Parameters:

init_options[in] object from which the allocator should be retrieved

Returns:

pointer to the rcl allocator, or

Returns:

NULL if there was an error