iceoryx2
C++ Language Bindings
Loading...
Searching...
No Matches
iox2::ServerDetailsView Class Reference

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

#include <server_details.hpp>

Public Member Functions

 ServerDetailsView (const ServerDetailsView &)=delete
 
 ServerDetailsView (ServerDetailsView &&rhs) noexcept
 
 ~ServerDetailsView () noexcept=default
 
auto operator= (const ServerDetailsView &) -> ServerDetailsView &=delete
 
auto operator= (ServerDetailsView &&rhs) noexcept -> ServerDetailsView &
 
auto server_id () const -> UniqueServerId
 The [UniqueServerId] of the [Server].
 
auto node_id () const -> UniqueNodeId
 The [NodeId] of the [Node] under which the [Server] was created.
 
auto request_buffer_size () const -> uint64_t
 The receive buffer size for incoming requests.
 
auto number_of_responses () const -> uint64_t
 The total number of responses available in the [Server].
 
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 [Server].

Definition at line 23 of file server_details.hpp.

Constructor & Destructor Documentation

◆ ServerDetailsView() [1/2]

iox2::ServerDetailsView::ServerDetailsView ( const ServerDetailsView )
delete

◆ ServerDetailsView() [2/2]

iox2::ServerDetailsView::ServerDetailsView ( ServerDetailsView &&  rhs)
noexcept

◆ ~ServerDetailsView()

iox2::ServerDetailsView::~ServerDetailsView ( )
defaultnoexcept

Member Function Documentation

◆ max_slice_len()

auto iox2::ServerDetailsView::max_slice_len ( ) const -> uint64_t

The current maximum length of a slice.

◆ node_id()

auto iox2::ServerDetailsView::node_id ( ) const -> UniqueNodeId

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

◆ number_of_responses()

auto iox2::ServerDetailsView::number_of_responses ( ) const -> uint64_t

The total number of responses available in the [Server].

◆ operator=() [1/2]

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

◆ operator=() [2/2]

auto iox2::ServerDetailsView::operator= ( ServerDetailsView &&  rhs) -> ServerDetailsView &
noexcept

◆ request_buffer_size()

auto iox2::ServerDetailsView::request_buffer_size ( ) const -> uint64_t

The receive buffer size for incoming requests.

◆ server_id()

auto iox2::ServerDetailsView::server_id ( ) const -> UniqueServerId

The [UniqueServerId] of the [Server].

Friends And Related Symbol Documentation

◆ internal::list_ports_callback

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

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