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

#include <dynamic_config_request_response.hpp>

Public Member Functions

 DynamicConfigRequestResponse (const DynamicConfigRequestResponse &)=delete
 
 DynamicConfigRequestResponse (DynamicConfigRequestResponse &&)=default
 
auto operator= (const DynamicConfigRequestResponse &) -> DynamicConfigRequestResponse &=delete
 
auto operator= (DynamicConfigRequestResponse &&) -> DynamicConfigRequestResponse &=delete
 
 ~DynamicConfigRequestResponse ()=default
 
auto number_of_clients () const -> uint64_t
 Returns how many [crate::port::client::Client] ports are currently connected.
 
auto number_of_servers () const -> uint64_t
 Returns how many [crate::port::server::Server] ports are currently connected.
 
void list_servers (const iox2::bb::StaticFunction< CallbackProgression(ServerDetailsView)> &callback) const
 
void list_clients (const iox2::bb::StaticFunction< CallbackProgression(ClientDetailsView)> &callback) const
 

Friends

template<ServiceType , typename , typename , typename , typename >
class PortFactoryRequestResponse
 

Detailed Description

The dynamic configuration of an [crate::service::messaging_pattern::MessagingPattern::RequestResponse] based service. Contains dynamic parameters like the connected endpoints etc..

Definition at line 29 of file dynamic_config_request_response.hpp.

Constructor & Destructor Documentation

◆ DynamicConfigRequestResponse() [1/2]

iox2::DynamicConfigRequestResponse::DynamicConfigRequestResponse ( const DynamicConfigRequestResponse )
delete

◆ DynamicConfigRequestResponse() [2/2]

iox2::DynamicConfigRequestResponse::DynamicConfigRequestResponse ( DynamicConfigRequestResponse &&  )
default

◆ ~DynamicConfigRequestResponse()

iox2::DynamicConfigRequestResponse::~DynamicConfigRequestResponse ( )
default

Member Function Documentation

◆ list_clients()

void iox2::DynamicConfigRequestResponse::list_clients ( const iox2::bb::StaticFunction< CallbackProgression(ClientDetailsView)> &  callback) const

Iterates over all [Client]s and calls the callback with the corresponding [ClientDetailsView]. The callback shall return [CallbackProgression::Continue] when the iteration shall continue otherwise [CallbackProgression::Stop].

◆ list_servers()

void iox2::DynamicConfigRequestResponse::list_servers ( const iox2::bb::StaticFunction< CallbackProgression(ServerDetailsView)> &  callback) const

Iterates over all [Server]s and calls the callback with the corresponding [ServerDetailsView]. The callback shall return [CallbackProgression::Continue] when the iteration shall continue otherwise [CallbackProgression::Stop].

◆ number_of_clients()

auto iox2::DynamicConfigRequestResponse::number_of_clients ( ) const -> uint64_t

Returns how many [crate::port::client::Client] ports are currently connected.

◆ number_of_servers()

auto iox2::DynamicConfigRequestResponse::number_of_servers ( ) const -> uint64_t

Returns how many [crate::port::server::Server] ports are currently connected.

◆ operator=() [1/2]

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

◆ operator=() [2/2]

auto iox2::DynamicConfigRequestResponse::operator= ( DynamicConfigRequestResponse &&  ) -> DynamicConfigRequestResponse &=delete
delete

Friends And Related Symbol Documentation

◆ PortFactoryRequestResponse

template<ServiceType , typename , typename , typename , typename >
friend class PortFactoryRequestResponse
friend

Definition at line 58 of file dynamic_config_request_response.hpp.


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