All configurable settings of a [Service]. More...

#include <config.hpp>

Public Member Functions
auto	flatbuffer_schema_path () &&-> bb::Optional< const char * >

void	set_flatbuffer_schema_path (bb::Optional< bb::Path > value) &&
	Set the flatbuffer schema lookup path.

auto	directory () &&-> const char *
	The directory in which all service files are stored.

void	set_directory (const iox2::bb::Path &value) &&
	Set the directory in which all service files are stored.

auto	data_segment_suffix () &&-> const char *
	The suffix of the ports data segment.

void	set_data_segment_suffix (const iox2::bb::FileName &value) &&
	Set the suffix of the ports data segment.

auto	static_config_storage_suffix () &&-> const char *
	The suffix of the static config file.

void	set_static_config_storage_suffix (const iox2::bb::FileName &value) &&
	Set the suffix of the static config file.

auto	dynamic_config_storage_suffix () &&-> const char *
	The suffix of the dynamic config file.

void	set_dynamic_config_storage_suffix (const iox2::bb::FileName &value) &&
	Set the suffix of the dynamic config file.

auto	connection_suffix () &&-> const char *
	The suffix of a one-to-one connection.

void	set_connection_suffix (const iox2::bb::FileName &value) &&
	Set the suffix of a one-to-one connection.

auto	event_connection_suffix () &&-> const char *
	The suffix of a one-to-one connection.

void	set_event_connection_suffix (const iox2::bb::FileName &value) &&
	Set the suffix of a one-to-one connection.

auto	cleanup_dead_nodes_on_open () &&-> bool

void	set_cleanup_dead_nodes_on_open (bool value) &&

Friends
class	Global

Detailed Description

All configurable settings of a [Service].

Definition at line 80 of file config.hpp.

Member Function Documentation

◆ cleanup_dead_nodes_on_open()

auto iox2::config::Service::cleanup_dead_nodes_on_open ( ) && -> bool

When true, the ServiceBuilder will clean up dead nodes when opening an existing service.

◆ connection_suffix()

auto iox2::config::Service::connection_suffix ( ) && -> const char *

The suffix of a one-to-one connection.

◆ data_segment_suffix()

auto iox2::config::Service::data_segment_suffix ( ) && -> const char *

The suffix of the ports data segment.

◆ directory()

auto iox2::config::Service::directory ( ) && -> const char *

The directory in which all service files are stored.

◆ dynamic_config_storage_suffix()

auto iox2::config::Service::dynamic_config_storage_suffix ( ) && -> const char *

The suffix of the dynamic config file.

◆ event_connection_suffix()

auto iox2::config::Service::event_connection_suffix ( ) && -> const char *

The suffix of a one-to-one connection.

◆ flatbuffer_schema_path()

auto iox2::config::Service::flatbuffer_schema_path ( ) && -> bb::Optional< const char * >

A list of directories where iceoryx2 will look for .fbs flatbuffer schemas. If no path is provided, iceoryx2 will perform no lookup and the user must explicitly define the path to the flatbuffer schemas.

◆ set_cleanup_dead_nodes_on_open()

void iox2::config::Service::set_cleanup_dead_nodes_on_open ( bool value ) &&

Sets if dead nodes shall be cleaned up whenever the ServiceBuilder opens an existing service.

◆ set_connection_suffix()

void iox2::config::Service::set_connection_suffix ( const iox2::bb::FileName & value ) &&

Set the suffix of a one-to-one connection.

◆ set_data_segment_suffix()

void iox2::config::Service::set_data_segment_suffix ( const iox2::bb::FileName & value ) &&

Set the suffix of the ports data segment.

◆ set_directory()

void iox2::config::Service::set_directory ( const iox2::bb::Path & value ) &&

Set the directory in which all service files are stored.

◆ set_dynamic_config_storage_suffix()

void iox2::config::Service::set_dynamic_config_storage_suffix ( const iox2::bb::FileName & value ) &&

Set the suffix of the dynamic config file.

◆ set_event_connection_suffix()

void iox2::config::Service::set_event_connection_suffix ( const iox2::bb::FileName & value ) &&

Set the suffix of a one-to-one connection.

◆ set_flatbuffer_schema_path()

void iox2::config::Service::set_flatbuffer_schema_path ( bb::Optional< bb::Path > value ) &&

Set the flatbuffer schema lookup path.

◆ set_static_config_storage_suffix()

void iox2::config::Service::set_static_config_storage_suffix ( const iox2::bb::FileName & value ) &&

Set the suffix of the static config file.

◆ static_config_storage_suffix()

auto iox2::config::Service::static_config_storage_suffix ( ) && -> const char *

The suffix of the static config file.

Friends And Related Symbol Documentation

◆ Global

friend class Global

friend

Definition at line 120 of file config.hpp.

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

iox2/config.hpp

Public Member Functions

Friends