Options structure used during rmw_init(). More...

#include <init_options.h>

Collaboration diagram for rmw_init_options_t:

Public Attributes
uint64_t	instance_id
	Locally (process local) unique ID that represents this init/shutdown cycle. More...

const char *	implementation_identifier
	Implementation identifier, used to ensure two different implementations are not being mixed. More...

rcutils_allocator_t	allocator
	Allocator used during internal allocation of init options, if needed. More...

rmw_init_options_impl_t *	impl
	Implementation defined init options. More...

Detailed Description

Options structure used during rmw_init().

Member Data Documentation

◆ instance_id

uint64_t rmw_init_options_t::instance_id

Locally (process local) unique ID that represents this init/shutdown cycle.

This should be set by the caller of rmw_init() to a number that is unique within this process. It is designed to be used with rcl_init() and rcl_get_instance_id().

◆ implementation_identifier

const char* rmw_init_options_t::implementation_identifier

Implementation identifier, used to ensure two different implementations are not being mixed.

◆ allocator

rcutils_allocator_t rmw_init_options_t::allocator

Allocator used during internal allocation of init options, if needed.

◆ impl

rmw_init_options_impl_t* rmw_init_options_t::impl

Implementation defined init options.

May be NULL if there are no implementation defined options.

The documentation for this struct was generated from the following file:

include/rmw/init_options.h