iox2::ClientDetailsView Class Reference

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

#include <client_details.hpp>

Public Member Functions
	ClientDetailsView (const ClientDetailsView &)=delete
	ClientDetailsView (ClientDetailsView &&rhs) noexcept
	~ClientDetailsView () noexcept=default
auto	operator= (const ClientDetailsView &) -> ClientDetailsView &=delete
auto	operator= (ClientDetailsView &&rhs) noexcept -> ClientDetailsView &
auto	client_id () const -> UniqueClientId
	The [UniqueClientId] of the [Client].
auto	node_id () const -> UniqueNodeId
	The [NodeId] of the [Node] under which the [Client] was created.
auto	response_buffer_size () const -> uint64_t
	The receive buffer size for incoming responses.
auto	number_of_requests () const -> uint64_t
	The total number of requests available in the [Client]s data segment.
auto	max_slice_len () const -> uint64_t
	The current maximum length of a slice.
auto	max_active_requests () const -> uint64_t
	The maximal amount of active requests the [Client] can send.

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

Definition at line 23 of file client_details.hpp.

Constructor & Destructor Documentation

ClientDetailsView() [1/2]

iox2::ClientDetailsView::ClientDetailsView ( const ClientDetailsView &  )

delete

ClientDetailsView() [2/2]

iox2::ClientDetailsView::ClientDetailsView ( ClientDetailsView &&  rhs )

noexcept

~ClientDetailsView()

iox2::ClientDetailsView::~ClientDetailsView ( )

defaultnoexcept

Member Function Documentation

client_id()

auto iox2::ClientDetailsView::client_id

(

)

const -> UniqueClientId

The [UniqueClientId] of the [Client].

max_active_requests()

auto iox2::ClientDetailsView::max_active_requests

(

)

const -> uint64_t

The maximal amount of active requests the [Client] can send.

max_slice_len()

auto iox2::ClientDetailsView::max_slice_len

(

)

const -> uint64_t

The current maximum length of a slice.

node_id()

auto iox2::ClientDetailsView::node_id

(

)

const -> UniqueNodeId

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

number_of_requests()

auto iox2::ClientDetailsView::number_of_requests

(

)

const -> uint64_t

The total number of requests available in the [Client]s data segment.

operator=() [1/2]

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

noexcept

operator=() [2/2]

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

delete

response_buffer_size()

auto iox2::ClientDetailsView::response_buffer_size

(

)

const -> uint64_t

The receive buffer size for incoming responses.

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