iox2::UniqueNodeId Class Reference

The system-wide unique id of a [Node]. More...

#include <unique_node_id.hpp>

Public Member Functions
	UniqueNodeId (const UniqueNodeId &rhs)
	UniqueNodeId (UniqueNodeId &&rhs) noexcept
auto	operator= (const UniqueNodeId &rhs) -> UniqueNodeId &
auto	operator= (UniqueNodeId &&rhs) noexcept -> UniqueNodeId &
	~UniqueNodeId ()
auto	value_high () const -> uint64_t
	Returns the high bits of the underlying value of the [NodeId].
auto	value_low () const -> uint64_t
	Returns the low bits of the underlying value of the [NodeId].
template<ServiceType T>
auto	pid () const -> bb::Expected< int32_t, UniqueIdGeneratorDetailsError >
	Returns the [ProcessId] of the process that owns the [Node].
template<ServiceType T>
auto	creation_time () const -> bb::Expected< timespec, UniqueIdGeneratorDetailsError >
	Returns the time the [Node] was created.

Friends
template<ServiceType >
class	Node
template<ServiceType >
class	DeadNodeView
class	ClientDetailsView
class	ServerDetailsView
class	NotifierDetailsView
class	ListenerDetailsView
class	PublisherDetailsView
class	ReaderDetailsView
class	SubscriberDetailsView
class	WriterDetailsView
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

The system-wide unique id of a [Node].

Definition at line 36 of file unique_node_id.hpp.

Constructor & Destructor Documentation

UniqueNodeId() [1/2]

iox2::UniqueNodeId::UniqueNodeId

(

const UniqueNodeId &

rhs

)

UniqueNodeId() [2/2]

iox2::UniqueNodeId::UniqueNodeId ( UniqueNodeId &&  rhs )

noexcept

~UniqueNodeId()

iox2::UniqueNodeId::~UniqueNodeId

(

)

Member Function Documentation

creation_time()

template<ServiceType T>

auto iox2::UniqueNodeId::creation_time ( ) const -> bb::Expected<timespec, UniqueIdGeneratorDetailsError>

inline

Returns the time the [Node] was created.

Definition at line 96 of file unique_node_id.hpp.

References iox2::bb::err().

operator=() [1/2]

auto iox2::UniqueNodeId::operator=

(

const UniqueNodeId &

rhs

)

-> UniqueNodeId &

operator=() [2/2]

auto iox2::UniqueNodeId::operator= ( UniqueNodeId &&  rhs ) -> UniqueNodeId &

noexcept

pid()

template<ServiceType T>

auto iox2::UniqueNodeId::pid ( ) const -> bb::Expected<int32_t, UniqueIdGeneratorDetailsError>

inline

Returns the [ProcessId] of the process that owns the [Node].

Definition at line 86 of file unique_node_id.hpp.

References iox2::bb::err(), and pid().

Referenced by pid().

value_high()

auto iox2::UniqueNodeId::value_high

(

)

const -> uint64_t

Returns the high bits of the underlying value of the [NodeId].

value_low()

auto iox2::UniqueNodeId::value_low

(

)

const -> uint64_t

Returns the low bits of the underlying value of the [NodeId].

Friends And Related Symbol Documentation

ClientDetailsView

friend class ClientDetailsView

friend

Definition at line 70 of file unique_node_id.hpp.

DeadNodeView

template<ServiceType >

friend class DeadNodeView

friend

Definition at line 62 of file unique_node_id.hpp.

internal::list_callback

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

ListenerDetailsView

friend class ListenerDetailsView

friend

Definition at line 73 of file unique_node_id.hpp.

Node

template<ServiceType >

friend class Node

friend

Definition at line 60 of file unique_node_id.hpp.

NotifierDetailsView

friend class NotifierDetailsView

friend

Definition at line 72 of file unique_node_id.hpp.

PublisherDetailsView

friend class PublisherDetailsView

friend

Definition at line 74 of file unique_node_id.hpp.

ReaderDetailsView

friend class ReaderDetailsView

friend

Definition at line 75 of file unique_node_id.hpp.

ServerDetailsView

friend class ServerDetailsView

friend

Definition at line 71 of file unique_node_id.hpp.

SubscriberDetailsView

friend class SubscriberDetailsView

friend

Definition at line 76 of file unique_node_id.hpp.

WriterDetailsView

friend class WriterDetailsView

friend

Definition at line 77 of file unique_node_id.hpp.

---

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

• iox2/unique_node_id.hpp