iox2::NodeBuilder Class Reference

Creates a new [Node]. More...

#include <node.hpp>

Public Member Functions
auto	name (const NodeName value) -> decltype(auto)
auto	config (const Config value) -> decltype(auto)
auto	signal_handling_mode (const SignalHandlingMode value) -> decltype(auto)
	NodeBuilder ()
	NodeBuilder (NodeBuilder &&)=default
auto	operator= (NodeBuilder &&) -> NodeBuilder &=default
	~NodeBuilder ()=default
	NodeBuilder (const NodeBuilder &)=delete
auto	operator= (const NodeBuilder &) -> NodeBuilder &=delete
template<ServiceType T>
auto	create () const &&-> bb::Expected< Node< T >, NodeCreationFailure >
	Creates a new [Node] for a specified [ServiceType].

Detailed Description

Creates a new [Node].

Definition at line 113 of file node.hpp.

Constructor & Destructor Documentation

NodeBuilder() [1/3]

iox2::NodeBuilder::NodeBuilder

(

)

NodeBuilder() [2/3]

iox2::NodeBuilder::NodeBuilder ( NodeBuilder &&  )

default

~NodeBuilder()

iox2::NodeBuilder::~NodeBuilder ( )

default

NodeBuilder() [3/3]

iox2::NodeBuilder::NodeBuilder ( const NodeBuilder &  )

delete

Member Function Documentation

config()

auto iox2::NodeBuilder::config

(

const Config

value

)

-> decltype(auto)

The [Config] that shall be used for the [Node]. If no [Config] is specified the [Config::global_config()] is used.

create()

template<ServiceType T>

auto iox2::NodeBuilder::create

(

)

const && -> bb::Expected< Node< T >, NodeCreationFailure >

Creates a new [Node] for a specified [ServiceType].

name()

auto iox2::NodeBuilder::name

(

const NodeName

value

)

-> decltype(auto)

The [NodeName] that shall be assigned to the [Node]. It does not have to be unique. If no [NodeName] is defined then the [Node] does not have a name.

operator=() [1/2]

auto iox2::NodeBuilder::operator= ( const NodeBuilder &  ) -> NodeBuilder &=delete

delete

operator=() [2/2]

auto iox2::NodeBuilder::operator= ( NodeBuilder &&  ) -> NodeBuilder &=default

default

signal_handling_mode()

auto iox2::NodeBuilder::signal_handling_mode

(

const SignalHandlingMode

value

)

-> decltype(auto)

Defines the [SignalHandlingMode] for the [Node]. It affects the [Node::wait()] call that returns any received signal via its [NodeWaitFailure]

---

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

• iox2/node.hpp