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

#include <dynamic_config_event.hpp>

Public Member Functions

 DynamicConfigEvent (const DynamicConfigEvent &)=delete
 
 DynamicConfigEvent (DynamicConfigEvent &&)=default
 
auto operator= (const DynamicConfigEvent &) -> DynamicConfigEvent &=delete
 
auto operator= (DynamicConfigEvent &&) -> DynamicConfigEvent &=delete
 
 ~DynamicConfigEvent ()=default
 
auto number_of_listeners () const -> uint64_t
 Returns how many [Listener] ports are currently connected.
 
auto number_of_notifiers () const -> uint64_t
 Returns how many [Notifier] ports are currently connected.
 
void list_notifiers (const iox2::bb::StaticFunction< CallbackProgression(NotifierDetailsView)> &callback) const
 
void list_listeners (const iox2::bb::StaticFunction< CallbackProgression(ListenerDetailsView)> &callback) const
 

Friends

template<ServiceType >
class PortFactoryEvent
 

Detailed Description

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

Definition at line 26 of file dynamic_config_event.hpp.

Constructor & Destructor Documentation

◆ DynamicConfigEvent() [1/2]

iox2::DynamicConfigEvent::DynamicConfigEvent ( const DynamicConfigEvent )
delete

◆ DynamicConfigEvent() [2/2]

iox2::DynamicConfigEvent::DynamicConfigEvent ( DynamicConfigEvent &&  )
default

◆ ~DynamicConfigEvent()

iox2::DynamicConfigEvent::~DynamicConfigEvent ( )
default

Member Function Documentation

◆ list_listeners()

void iox2::DynamicConfigEvent::list_listeners ( const iox2::bb::StaticFunction< CallbackProgression(ListenerDetailsView)> &  callback) const

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

◆ list_notifiers()

void iox2::DynamicConfigEvent::list_notifiers ( const iox2::bb::StaticFunction< CallbackProgression(NotifierDetailsView)> &  callback) const

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

◆ number_of_listeners()

auto iox2::DynamicConfigEvent::number_of_listeners ( ) const -> uint64_t

Returns how many [Listener] ports are currently connected.

◆ number_of_notifiers()

auto iox2::DynamicConfigEvent::number_of_notifiers ( ) const -> uint64_t

Returns how many [Notifier] ports are currently connected.

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

Friends And Related Symbol Documentation

◆ PortFactoryEvent

template<ServiceType >
friend class PortFactoryEvent
friend

Definition at line 55 of file dynamic_config_event.hpp.


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