#include <static_config_event.hpp>

Public Member Functions
auto	max_nodes () const -> size_t

auto	max_notifiers () const -> size_t
	Returns the maximum supported amount of [`Notifier`] ports.

auto	max_listeners () const -> size_t
	Returns the maximum supported amount of [`Listener`] ports.

auto	event_id_max_value () const -> size_t
	Returns the largest [`EventId`] that is supported by the service.

auto	notifier_created_event () const -> bb::Optional< EventId >
	Returns the emitted [`EventId`] when a new notifier is created.

auto	notifier_dropped_event () const -> bb::Optional< EventId >
	Returns the emitted [`EventId`] when a notifier is dropped.

auto	notifier_dead_event () const -> bb::Optional< EventId >
	Returns the emitted [`EventId`] when a notifier is identified as dead.

auto	deadline () const -> bb::Optional< iox2::bb::Duration >

Friends
template<ServiceType >
class	PortFactoryEvent

class	StaticConfig

Detailed Description

The static configuration of an [MessagingPattern::Event] based service. Contains all parameters that do not change during the lifetime of a [Service].

Definition at line 27 of file static_config_event.hpp.

Member Function Documentation

◆ deadline()

auto iox2::StaticConfigEvent::deadline ( ) const -> bb::Optional< iox2::bb::Duration >

Returns the deadline of the service. If no new notification is signaled from any [Notifier] after the given deadline, it is rated as an error and all [Listener]s that are attached to a [WaitSet] are woken up and notified about the missed deadline.

◆ event_id_max_value()

auto iox2::StaticConfigEvent::event_id_max_value ( ) const -> size_t

Returns the largest [EventId] that is supported by the service.

◆ max_listeners()

auto iox2::StaticConfigEvent::max_listeners ( ) const -> size_t

Returns the maximum supported amount of [Listener] ports.

◆ max_nodes()

auto iox2::StaticConfigEvent::max_nodes ( ) const -> size_t

Returns the maximum supported amount of [Node]s that can open the [Service] in parallel.

◆ max_notifiers()

auto iox2::StaticConfigEvent::max_notifiers ( ) const -> size_t

Returns the maximum supported amount of [Notifier] ports.

◆ notifier_created_event()

auto iox2::StaticConfigEvent::notifier_created_event ( ) const -> bb::Optional< EventId >

Returns the emitted [EventId] when a new notifier is created.

◆ notifier_dead_event()

auto iox2::StaticConfigEvent::notifier_dead_event ( ) const -> bb::Optional< EventId >

Returns the emitted [EventId] when a notifier is identified as dead.

◆ notifier_dropped_event()

auto iox2::StaticConfigEvent::notifier_dropped_event ( ) const -> bb::Optional< EventId >

Returns the emitted [EventId] when a notifier is dropped.

Friends And Related Symbol Documentation

◆ PortFactoryEvent

template<ServiceType >

friend class PortFactoryEvent

friend

Definition at line 60 of file static_config_event.hpp.

◆ StaticConfig

friend class StaticConfig