iox2::AliveNodeView< ServiceType > Class Template Reference

Contains all details of a [Node] that is alive. More...

#include <node_state.hpp>

Public Member Functions
	AliveNodeView (const AliveNodeView &)=default
	AliveNodeView (AliveNodeView &&)=default
auto	operator= (const AliveNodeView &) -> AliveNodeView &=default
auto	operator= (AliveNodeView &&) -> AliveNodeView &=default
	~AliveNodeView ()=default
	AliveNodeView (UniqueNodeId node_id, const bb::Optional< NodeDetails > &details)
auto	id () const -> const UniqueNodeId &
	Returns the [NodeId].
auto	details () const -> const bb::Optional< NodeDetails > &

Detailed Description

template<ServiceType>
class iox2::AliveNodeView< ServiceType >

Contains all details of a [Node] that is alive.

Definition at line 28 of file node_state.hpp.

Constructor & Destructor Documentation

AliveNodeView() [1/3]

template<ServiceType >

iox2::AliveNodeView< ServiceType >::AliveNodeView ( const AliveNodeView< ServiceType > &  )

default

AliveNodeView() [2/3]

template<ServiceType >

iox2::AliveNodeView< ServiceType >::AliveNodeView ( AliveNodeView< ServiceType > &&  )

default

~AliveNodeView()

template<ServiceType >

iox2::AliveNodeView< ServiceType >::~AliveNodeView ( )

default

AliveNodeView() [3/3]

template<ServiceType >

iox2::AliveNodeView< ServiceType >::AliveNodeView	(	UniqueNodeId	node_id,
		const bb::Optional< NodeDetails > &	details
	)

Member Function Documentation

details()

template<ServiceType >

auto iox2::AliveNodeView< ServiceType >::details

(

)

const -> const bb::Optional< NodeDetails > &

Returns optional [NodeDetails] that contains further information about the [Node]. Can only be acquired when the process has the access right to read it.

id()

template<ServiceType >

auto iox2::AliveNodeView< ServiceType >::id

(

)

const -> const UniqueNodeId &

Returns the [NodeId].

operator=() [1/2]

template<ServiceType >

auto iox2::AliveNodeView< ServiceType >::operator= ( AliveNodeView< ServiceType > &&  ) -> AliveNodeView &=default

default

operator=() [2/2]

template<ServiceType >

auto iox2::AliveNodeView< ServiceType >::operator= ( const AliveNodeView< ServiceType > &  ) -> AliveNodeView &=default

default

---

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

• iox2/node_state.hpp