Function rcl_init_options_set_domain_id

Function Documentation

rcl_ret_t rcl_init_options_set_domain_id(rcl_init_options_t *init_options, size_t domain_id)

Set a domain id in the init options provided.

Store the domain id in the specified init_options object.

Attribute

Adherence

Allocates Memory

No

Thread-Safe

Yes

Uses Atomics

No

Lock-Free

Yes

Parameters:

  • init_options – [in] objects in which to set the specified domain id.

  • domain_id – [in] domain id to be set in init_options object.

Returns:

RCL_RET_OK if successful, or

Returns:

RCL_RET_INVALID_ARGUMENT if any arguments are invalid.