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

#include <dynamic_config_blackboard.hpp>

Public Member Functions

 DynamicConfigBlackboard (const DynamicConfigBlackboard &)=delete
 
 DynamicConfigBlackboard (DynamicConfigBlackboard &&)=default
 
auto operator= (const DynamicConfigBlackboard &) -> DynamicConfigBlackboard &=delete
 
auto operator= (DynamicConfigBlackboard &&) -> DynamicConfigBlackboard &=delete
 
 ~DynamicConfigBlackboard ()=default
 
auto number_of_readers () const -> uint64_t
 Returns how many [Reader] ports are currently connected.
 
auto number_of_writers () const -> uint64_t
 Returns how many [Writer] ports are currently connected.
 
void list_readers (const iox2::bb::StaticFunction< CallbackProgression(ReaderDetailsView)> &callback) const
 
void list_writers (const iox2::bb::StaticFunction< CallbackProgression(WriterDetailsView)> &callback) const
 

Friends

template<ServiceType , typename >
class PortFactoryBlackboard
 

Detailed Description

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

Definition at line 26 of file dynamic_config_blackboard.hpp.

Constructor & Destructor Documentation

◆ DynamicConfigBlackboard() [1/2]

iox2::DynamicConfigBlackboard::DynamicConfigBlackboard ( const DynamicConfigBlackboard )
delete

◆ DynamicConfigBlackboard() [2/2]

iox2::DynamicConfigBlackboard::DynamicConfigBlackboard ( DynamicConfigBlackboard &&  )
default

◆ ~DynamicConfigBlackboard()

iox2::DynamicConfigBlackboard::~DynamicConfigBlackboard ( )
default

Member Function Documentation

◆ list_readers()

void iox2::DynamicConfigBlackboard::list_readers ( const iox2::bb::StaticFunction< CallbackProgression(ReaderDetailsView)> &  callback) const

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

◆ list_writers()

void iox2::DynamicConfigBlackboard::list_writers ( const iox2::bb::StaticFunction< CallbackProgression(WriterDetailsView)> &  callback) const

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

◆ number_of_readers()

auto iox2::DynamicConfigBlackboard::number_of_readers ( ) const -> uint64_t

Returns how many [Reader] ports are currently connected.

◆ number_of_writers()

auto iox2::DynamicConfigBlackboard::number_of_writers ( ) const -> uint64_t

Returns how many [Writer] ports are currently connected.

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

Friends And Related Symbol Documentation

◆ PortFactoryBlackboard

template<ServiceType , typename >
friend class PortFactoryBlackboard
friend

Definition at line 55 of file dynamic_config_blackboard.hpp.


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