iox2::config::Node Class Reference

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

#include <config.hpp>

Public Member Functions
auto	directory () &&-> const char *
	The directory in which all node files are stored.
void	set_directory (const iox2::bb::Path &value) &&
	Set the directory in which all node files are stored.
auto	monitor_suffix () &&-> const char *
	The suffix of the monitor token.
void	set_monitor_suffix (const iox2::bb::FileName &value) &&
	Set the suffix of the monitor token.
auto	global_mgmt_suffix () &&-> const char *
	The suffix of the files where the node configuration is stored.
void	set_global_mgmt_suffix (const iox2::bb::FileName &value) &&
	Set the suffix of the files where the node configuration is stored.
auto	static_config_suffix () &&-> const char *
	The suffix of the files where the node configuration is stored.
void	set_static_config_suffix (const iox2::bb::FileName &value) &&
	Set the suffix of the files where the node configuration is stored.
auto	port_tag_suffix () &&-> const char *
	The suffix of the service tags.
void	set_port_tag_suffix (const iox2::bb::FileName &value) &&
	Set the suffix of the service tags.
auto	service_tag_suffix () &&-> const char *
	The suffix of the service tags.
void	set_service_tag_suffix (const iox2::bb::FileName &value) &&
	Set the suffix of the service tags.
auto	cleanup_dead_nodes_on_creation () &&-> bool
void	set_cleanup_dead_nodes_on_creation (bool value) &&
	Enable/disable the cleanup dead nodes on creation.
auto	cleanup_dead_nodes_on_destruction () &&-> bool
void	set_cleanup_dead_nodes_on_destruction (bool value) &&
	Enable/disable the cleanup dead nodes on destruction.

Friends
class	Global

Detailed Description

All configurable settings of a [Node].

Definition at line 33 of file config.hpp.

Member Function Documentation

cleanup_dead_nodes_on_creation()

auto iox2::config::Node::cleanup_dead_nodes_on_creation

(

)

&& -> bool

When true, the [NodeBuilder](NodeBuilder) checks for dead nodes and cleans up all their stale resources whenever a new [Node](Node) is created.

cleanup_dead_nodes_on_destruction()

auto iox2::config::Node::cleanup_dead_nodes_on_destruction

(

)

&& -> bool

When true, the [NodeBuilder](NodeBuilder) checks for dead nodes and cleans up all their stale resources whenever an existing [Node](Node) is going out of scope.

directory()

auto iox2::config::Node::directory

(

)

&& -> const char *

The directory in which all node files are stored.

global_mgmt_suffix()

auto iox2::config::Node::global_mgmt_suffix

(

)

&& -> const char *

The suffix of the files where the node configuration is stored.

monitor_suffix()

auto iox2::config::Node::monitor_suffix

(

)

&& -> const char *

The suffix of the monitor token.

port_tag_suffix()

auto iox2::config::Node::port_tag_suffix

(

)

&& -> const char *

The suffix of the service tags.

service_tag_suffix()

auto iox2::config::Node::service_tag_suffix

(

)

&& -> const char *

The suffix of the service tags.

set_cleanup_dead_nodes_on_creation()

void iox2::config::Node::set_cleanup_dead_nodes_on_creation

(

bool

value

)

&&

Enable/disable the cleanup dead nodes on creation.

set_cleanup_dead_nodes_on_destruction()

void iox2::config::Node::set_cleanup_dead_nodes_on_destruction

(

bool

value

)

&&

Enable/disable the cleanup dead nodes on destruction.

set_directory()

void iox2::config::Node::set_directory

(

const iox2::bb::Path &

value

)

&&

Set the directory in which all node files are stored.

set_global_mgmt_suffix()

void iox2::config::Node::set_global_mgmt_suffix

(

const iox2::bb::FileName &

value

)

&&

Set the suffix of the files where the node configuration is stored.

set_monitor_suffix()

void iox2::config::Node::set_monitor_suffix

(

const iox2::bb::FileName &

value

)

&&

Set the suffix of the monitor token.

set_port_tag_suffix()

void iox2::config::Node::set_port_tag_suffix

(

const iox2::bb::FileName &

value

)

&&

Set the suffix of the service tags.

set_service_tag_suffix()

void iox2::config::Node::set_service_tag_suffix

(

const iox2::bb::FileName &

value

)

&&

Set the suffix of the service tags.

set_static_config_suffix()

void iox2::config::Node::set_static_config_suffix

(

const iox2::bb::FileName &

value

)

&&

Set the suffix of the files where the node configuration is stored.

static_config_suffix()

auto iox2::config::Node::static_config_suffix

(

)

&& -> const char *

The suffix of the files where the node configuration is stored.

Friends And Related Symbol Documentation

Global

friend class Global

friend

Definition at line 73 of file config.hpp.

---

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

• iox2/config.hpp