iox2::Config Class Reference

#include <config.hpp>

Public Member Functions
	Config ()
	Config (const Config &rhs)
	Config (Config &&rhs) noexcept
	~Config ()
auto	operator= (const Config &rhs) -> Config &
auto	operator= (Config &&rhs) noexcept -> Config &
auto	global () -> config::Global
	Returns the [config::Global] part of the config.
auto	defaults () -> config::Defaults
	Returns the [config::Defaults] part of the config.
auto	view () -> ConfigView
	Returns the [ConfigView] to this [Config].

Static Public Member Functions
static auto	from_file (const iox2::bb::FilePath &file) -> iox2::bb::Expected< Config, ConfigCreationError >
static auto	setup_global_config_from_file (const iox2::bb::FilePath &file) -> iox2::bb::Expected< ConfigView, ConfigCreationError >
static auto	global_config () -> ConfigView
	Returns a [ConfigView] to the current global config.

Friends
class	ConfigView
class	config::Global
class	NodeBuilder
template<ServiceType >
class	DeadNodeView

Detailed Description

Represents the configuration that iceoryx2 will utilize. It is divided into two sections: the [Global] settings, which must align with the iceoryx2 instance the application intends to join, and the [Defaults] for communication within that iceoryx2 instance. The user has the flexibility to override both sections.

Definition at line 444 of file config.hpp.

Constructor & Destructor Documentation

Config() [1/3]

iox2::Config::Config

(

)

Config() [2/3]

iox2::Config::Config

(

const Config &

rhs

)

Config() [3/3]

iox2::Config::Config ( Config &&  rhs )

noexcept

~Config()

iox2::Config::~Config

(

)

Member Function Documentation

defaults()

auto iox2::Config::defaults

(

)

-> config::Defaults

Returns the [config::Defaults] part of the config.

from_file()

static auto iox2::Config::from_file ( const iox2::bb::FilePath &  file ) -> iox2::bb::Expected< Config, ConfigCreationError >

static

Loads a configuration from a file. On success it returns a [Config] object otherwise a [ConfigCreationError] describing the failure.

global()

auto iox2::Config::global

(

)

-> config::Global

Returns the [config::Global] part of the config.

global_config()

static auto iox2::Config::global_config ( ) -> ConfigView

static

Returns a [ConfigView] to the current global config.

operator=() [1/2]

auto iox2::Config::operator= ( Config &&  rhs ) -> Config &

noexcept

operator=() [2/2]

auto iox2::Config::operator=

(

const Config &

rhs

)

-> Config &

setup_global_config_from_file()

static auto iox2::Config::setup_global_config_from_file ( const iox2::bb::FilePath &  file ) -> iox2::bb::Expected< ConfigView, ConfigCreationError >

static

Sets the global configuration from a file. On success it returns the global config as [ConfigView] object otherwise a [ConfigCreationError] describing the failure.

view()

auto iox2::Config::view

(

)

-> ConfigView

Returns the [ConfigView] to this [Config].

Friends And Related Symbol Documentation

config::Global

friend class config::Global

friend

Definition at line 476 of file config.hpp.

ConfigView

friend class ConfigView

friend

Definition at line 475 of file config.hpp.

DeadNodeView

template<ServiceType >

friend class DeadNodeView

friend

Definition at line 479 of file config.hpp.

NodeBuilder

friend class NodeBuilder

friend

Definition at line 477 of file config.hpp.

---

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

• iox2/config.hpp