iox2::PublisherDetailsView Class Reference

Contains the communication settings of the connected [Publisher]. More...

#include <publisher_details.hpp>

Public Member Functions
	PublisherDetailsView (const PublisherDetailsView &)=delete
	PublisherDetailsView (PublisherDetailsView &&rhs) noexcept
	~PublisherDetailsView () noexcept=default
auto	operator= (const PublisherDetailsView &) -> PublisherDetailsView &=delete
auto	operator= (PublisherDetailsView &&rhs) noexcept -> PublisherDetailsView &
auto	publisher_id () const -> UniquePublisherId
	The [UniquePublisherId] of the [Publisher].
auto	node_id () const -> UniqueNodeId
	The [NodeId] of the [Node] under which the [Publisher] was created.
auto	number_of_samples () const -> uint64_t
	The total number of samples available in the [Publisher]s data segment.
auto	max_slice_len () const -> uint64_t
	The current maximum length of a slice.

Friends
template<typename T , typename >
auto	internal::list_ports_callback (void *context, T port_details_view) -> iox2_callback_progression_e

Detailed Description

Contains the communication settings of the connected [Publisher].

Definition at line 23 of file publisher_details.hpp.

Constructor & Destructor Documentation

PublisherDetailsView() [1/2]

iox2::PublisherDetailsView::PublisherDetailsView ( const PublisherDetailsView &  )

delete

PublisherDetailsView() [2/2]

iox2::PublisherDetailsView::PublisherDetailsView ( PublisherDetailsView &&  rhs )

noexcept

~PublisherDetailsView()

iox2::PublisherDetailsView::~PublisherDetailsView ( )

defaultnoexcept

Member Function Documentation

max_slice_len()

auto iox2::PublisherDetailsView::max_slice_len

(

)

const -> uint64_t

The current maximum length of a slice.

node_id()

auto iox2::PublisherDetailsView::node_id

(

)

const -> UniqueNodeId

The [NodeId] of the [Node] under which the [Publisher] was created.

number_of_samples()

auto iox2::PublisherDetailsView::number_of_samples

(

)

const -> uint64_t

The total number of samples available in the [Publisher]s data segment.

operator=() [1/2]

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

delete

operator=() [2/2]

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

noexcept

publisher_id()

auto iox2::PublisherDetailsView::publisher_id

(

)

const -> UniquePublisherId

The [UniquePublisherId] of the [Publisher].

Friends And Related Symbol Documentation

internal::list_ports_callback

template<typename T , typename >

auto internal::list_ports_callback ( void *  context, T  port_details_view  ) -> iox2_callback_progression_e

friend

---

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

• iox2/publisher_details.hpp