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

#include <dynamic_config_publish_subscribe.hpp>

Public Member Functions

 DynamicConfigPublishSubscribe (const DynamicConfigPublishSubscribe &)=delete
 
 DynamicConfigPublishSubscribe (DynamicConfigPublishSubscribe &&)=default
 
auto operator= (const DynamicConfigPublishSubscribe &) -> DynamicConfigPublishSubscribe &=delete
 
auto operator= (DynamicConfigPublishSubscribe &&) -> DynamicConfigPublishSubscribe &=delete
 
 ~DynamicConfigPublishSubscribe ()=default
 
auto number_of_publishers () const -> uint64_t
 Returns how many [Publisher] ports are currently connected.
 
auto number_of_subscribers () const -> uint64_t
 Returns how many [Subscriber] ports are currently connected.
 
void list_publishers (const iox2::bb::StaticFunction< CallbackProgression(PublisherDetailsView)> &callback) const
 
void list_subscribers (const iox2::bb::StaticFunction< CallbackProgression(SubscriberDetailsView)> &callback) const
 

Friends

template<ServiceType , typename , typename >
class PortFactoryPublishSubscribe
 

Detailed Description

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

Definition at line 28 of file dynamic_config_publish_subscribe.hpp.

Constructor & Destructor Documentation

◆ DynamicConfigPublishSubscribe() [1/2]

iox2::DynamicConfigPublishSubscribe::DynamicConfigPublishSubscribe ( const DynamicConfigPublishSubscribe )
delete

◆ DynamicConfigPublishSubscribe() [2/2]

iox2::DynamicConfigPublishSubscribe::DynamicConfigPublishSubscribe ( DynamicConfigPublishSubscribe &&  )
default

◆ ~DynamicConfigPublishSubscribe()

iox2::DynamicConfigPublishSubscribe::~DynamicConfigPublishSubscribe ( )
default

Member Function Documentation

◆ list_publishers()

void iox2::DynamicConfigPublishSubscribe::list_publishers ( const iox2::bb::StaticFunction< CallbackProgression(PublisherDetailsView)> &  callback) const

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

◆ list_subscribers()

void iox2::DynamicConfigPublishSubscribe::list_subscribers ( const iox2::bb::StaticFunction< CallbackProgression(SubscriberDetailsView)> &  callback) const

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

◆ number_of_publishers()

auto iox2::DynamicConfigPublishSubscribe::number_of_publishers ( ) const -> uint64_t

Returns how many [Publisher] ports are currently connected.

◆ number_of_subscribers()

auto iox2::DynamicConfigPublishSubscribe::number_of_subscribers ( ) const -> uint64_t

Returns how many [Subscriber] ports are currently connected.

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

Friends And Related Symbol Documentation

◆ PortFactoryPublishSubscribe

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

Definition at line 57 of file dynamic_config_publish_subscribe.hpp.


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