iox2::NodeState< T > Class Template Reference

Describes the state of a [Node]. More...

#include <node_state.hpp>

Public Member Functions
	NodeState (const NodeState &)=default
	NodeState (NodeState &&)=default
auto	operator= (const NodeState &) -> NodeState &=default
auto	operator= (NodeState &&) -> NodeState &=default
	~NodeState ()=default
auto	alive (const iox2::bb::StaticFunction< void(AliveNodeView< T > &)> &callback) -> NodeState &
auto	dead (const iox2::bb::StaticFunction< void(DeadNodeView< T > &)> &callback) -> NodeState &
auto	inaccessible (const iox2::bb::StaticFunction< void(UniqueNodeId &)> &callback) -> NodeState &
auto	undefined (const iox2::bb::StaticFunction< void(UniqueNodeId &)> &callback) -> NodeState &

Friends
template<ServiceType >
auto	internal::list_callback (iox2_node_state_e, iox2_unique_node_id_ptr, const char *, iox2_node_name_ptr, iox2_config_ptr, iox2_callback_context) -> iox2_callback_progression_e

Detailed Description

template<ServiceType T>
class iox2::NodeState< T >

Describes the state of a [Node].

Definition at line 90 of file node_state.hpp.

Constructor & Destructor Documentation

NodeState() [1/2]

template<ServiceType T>

iox2::NodeState< T >::NodeState ( const NodeState< T > &  )

default

NodeState() [2/2]

template<ServiceType T>

iox2::NodeState< T >::NodeState ( NodeState< T > &&  )

default

~NodeState()

template<ServiceType T>

iox2::NodeState< T >::~NodeState ( )

default

Member Function Documentation

alive()

template<ServiceType T>

auto iox2::NodeState< T >::alive

(

const iox2::bb::StaticFunction< void(AliveNodeView< T > &)> &

callback

)

-> NodeState &

If the [Node] is alive the provided callback is called with an [AliveNodeView] as argument.

dead()

template<ServiceType T>

auto iox2::NodeState< T >::dead

(

const iox2::bb::StaticFunction< void(DeadNodeView< T > &)> &

callback

)

-> NodeState &

If the [Node] is dead the provided callback is called with a [DeadNodeView] as argument.

inaccessible()

template<ServiceType T>

auto iox2::NodeState< T >::inaccessible

(

const iox2::bb::StaticFunction< void(UniqueNodeId &)> &

callback

)

-> NodeState &

If the [Node] is inaccessible due to a lack of permissions the provided callback is called with a [NodeId] as argument.

operator=() [1/2]

template<ServiceType T>

auto iox2::NodeState< T >::operator= ( const NodeState< T > &  ) -> NodeState &=default

default

operator=() [2/2]

template<ServiceType T>

auto iox2::NodeState< T >::operator= ( NodeState< T > &&  ) -> NodeState &=default

default

undefined()

template<ServiceType T>

auto iox2::NodeState< T >::undefined

(

const iox2::bb::StaticFunction< void(UniqueNodeId &)> &

callback

)

-> NodeState &

If the [Node] is files are corrupted or some essential constructs are missing the provided callback is called with a [NodeId] as argument.

Friends And Related Symbol Documentation

internal::list_callback

template<ServiceType T>

template<ServiceType >

auto internal::list_callback ( iox2_node_state_e  , iox2_unique_node_id_ptr  , const char *  , iox2_node_name_ptr  , iox2_config_ptr  , iox2_callback_context    ) -> iox2_callback_progression_e

friend

---

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

• iox2/node_state.hpp