iox2::SubscriberDetailsView Class Reference

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

#include <subscriber_details.hpp>

Public Member Functions
	SubscriberDetailsView (const SubscriberDetailsView &)=delete
	SubscriberDetailsView (SubscriberDetailsView &&rhs) noexcept
	~SubscriberDetailsView () noexcept=default
auto	operator= (const SubscriberDetailsView &) -> SubscriberDetailsView &=delete
auto	operator= (SubscriberDetailsView &&rhs) noexcept -> SubscriberDetailsView &
auto	subscriber_id () const -> UniqueSubscriberId
	The [UniqueSubscriberId] of the [Subscriber].
auto	node_id () const -> UniqueNodeId
	The [NodeId] of the [Node] under which the [Subscriber] was created.
auto	buffer_size () const -> uint64_t
	The receive buffer size for incoming samples.
auto	history_request () const -> uint64_t
	The history request for the subscriber.

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 [Subscriber].

Definition at line 23 of file subscriber_details.hpp.

Constructor & Destructor Documentation

SubscriberDetailsView() [1/2]

iox2::SubscriberDetailsView::SubscriberDetailsView ( const SubscriberDetailsView &  )

delete

SubscriberDetailsView() [2/2]

iox2::SubscriberDetailsView::SubscriberDetailsView ( SubscriberDetailsView &&  rhs )

noexcept

~SubscriberDetailsView()

iox2::SubscriberDetailsView::~SubscriberDetailsView ( )

defaultnoexcept

Member Function Documentation

buffer_size()

auto iox2::SubscriberDetailsView::buffer_size

(

)

const -> uint64_t

The receive buffer size for incoming samples.

history_request()

auto iox2::SubscriberDetailsView::history_request

(

)

const -> uint64_t

The history request for the subscriber.

node_id()

auto iox2::SubscriberDetailsView::node_id

(

)

const -> UniqueNodeId

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

operator=() [1/2]

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

delete

operator=() [2/2]

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

noexcept

subscriber_id()

auto iox2::SubscriberDetailsView::subscriber_id

(

)

const -> UniqueSubscriberId

The [UniqueSubscriberId] of the [Subscriber].

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/subscriber_details.hpp