iceoryx2
C++ Language Bindings
Loading...
Searching...
No Matches
iox2::config::Global Class Reference

The global settings. More...

#include <config.hpp>

Public Member Functions

auto prefix () &&-> const char *
 Prefix used for all files created during runtime.
 
void set_prefix (const iox2::bb::FileName &value) &&
 Set the prefix used for all files created during runtime.
 
auto root_path () &&-> const char *
 The path under which all other directories or files will be created.
 
void set_root_path (const iox2::bb::Path &value) &&
 Defines the path under which all other directories or files will be created.
 
auto creation_timeout () &&-> iox2::bb::Duration
 
void set_creation_timeout (const iox2::bb::Duration &value) &&
 Set the creation timeout.
 
auto service () -> Service
 Returns the service part of the global configuration.
 
auto node () -> Node
 Returns the node part of the global configuration.
 

Friends

class ::iox2::Config
 

Detailed Description

The global settings.

Definition at line 121 of file config.hpp.

Member Function Documentation

◆ creation_timeout()

auto iox2::config::Global::creation_timeout ( ) && -> iox2::bb::Duration

Defines the time of how long another process will wait until an entity creation is finished. An entity could be a Node or a Service

◆ node()

auto iox2::config::Global::node ( ) -> Node

Returns the node part of the global configuration.

◆ prefix()

auto iox2::config::Global::prefix ( ) && -> const char *

Prefix used for all files created during runtime.

◆ root_path()

auto iox2::config::Global::root_path ( ) && -> const char *

The path under which all other directories or files will be created.

◆ service()

auto iox2::config::Global::service ( ) -> Service

Returns the service part of the global configuration.

◆ set_creation_timeout()

void iox2::config::Global::set_creation_timeout ( const iox2::bb::Duration value) &&

Set the creation timeout.

◆ set_prefix()

void iox2::config::Global::set_prefix ( const iox2::bb::FileName value) &&

Set the prefix used for all files created during runtime.

◆ set_root_path()

void iox2::config::Global::set_root_path ( const iox2::bb::Path value) &&

Defines the path under which all other directories or files will be created.

Friends And Related Symbol Documentation

◆ ::iox2::Config

friend class ::iox2::Config
friend

Definition at line 144 of file config.hpp.


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