Function rcl_init_options_init

Function Documentation

rcl_ret_t rcl_init_options_init(rcl_init_options_t *init_options, rcl_allocator_t allocator)

Initialize given init_options with the default values and implementation specific values.

The given allocator is used, if required, during setup of the init options, but is also used during initialization.

In either case the given allocator is stored in the returned init options.

The impl pointer should not be changed manually.

Attribute

Adherence

Allocates Memory

Yes

Thread-Safe

No

Uses Atomics

Yes

Lock-Free

Yes

Parameters:

  • init_options – [inout] object to be setup

  • allocator – [in] to be used during setup and during initialization

Returns:

RCL_RET_OK if setup is successful, or

Returns:

RCL_RET_ALREADY_INIT if init_options has already be initialized, or

Returns:

RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or

Returns:

RCL_RET_BAD_ALLOC if allocating memory failed, or

Returns:

RCL_RET_ERROR if an unspecified error occurs.