#include <config.hpp>

Public Member Functions
auto	max_listeners () &&-> size_t
	The maximum amount of supported [`Listener`].

void	set_max_listeners (size_t value) &&
	Set the maximum amount of supported [`Listener`].

auto	max_notifiers () &&-> size_t
	The maximum amount of supported [`Notifier`].

void	set_max_notifiers (size_t value) &&
	Set the maximum amount of supported [`Notifier`].

auto	max_nodes () &&-> size_t

void	set_max_nodes (size_t value) &&
	Set the maximum amount of supported [`Node`]s.

auto	event_id_max_value () &&-> size_t
	The largest event id supported by the event service.

void	set_event_id_max_value (size_t value) &&
	Set the largest event id supported by the event service.

auto	notifier_created_event () &&-> bb::Optional< size_t >
	Defines the event id value that is emitted after a new notifier was created.

void	set_notifier_created_event (bb::Optional< size_t > value) &&
	Sets the event id value that is emitted after a new notifier was created.

auto	notifier_dropped_event () &&-> bb::Optional< size_t >
	Defines the event id value that is emitted before a new notifier is dropped.

void	set_notifier_dropped_event (bb::Optional< size_t > value) &&
	Sets the event id value that is emitted before a new notifier is dropped.

auto	notifier_dead_event () &&-> bb::Optional< size_t >
	Defines the event id value that is emitted if a notifier was identified as dead.

void	set_notifier_dead_event (bb::Optional< size_t > value) &&
	Sets the event id value that is emitted if a notifier was identified as dead.

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

void	set_deadline (bb::Optional< iox2::bb::Duration > deadline) &&
	Sets the deadline of the event service.

Friends
class	Defaults

Detailed Description

Default settings for the event messaging pattern. These settings are used unless the user specifies custom QoS or port settings.

Definition at line 212 of file config.hpp.

Member Function Documentation

◆ deadline()

auto iox2::config::Event::deadline ( ) && -> bb::Optional< iox2::bb::Duration >

Defines the maximum allowed time between two consecutive notifications. If a notifiation is not sent after the defined time, every [Listener] that is attached to a [WaitSet] will be notified.

◆ event_id_max_value()

auto iox2::config::Event::event_id_max_value ( ) && -> size_t

The largest event id supported by the event service.

◆ max_listeners()

auto iox2::config::Event::max_listeners ( ) && -> size_t

The maximum amount of supported [Listener].

◆ max_nodes()

auto iox2::config::Event::max_nodes ( ) && -> size_t

The maximum amount of supported [Node]s. Defines indirectly how many processes can open the service at the same time.

◆ max_notifiers()

auto iox2::config::Event::max_notifiers ( ) && -> size_t

The maximum amount of supported [Notifier].

◆ notifier_created_event()

auto iox2::config::Event::notifier_created_event ( ) && -> bb::Optional< size_t >

Defines the event id value that is emitted after a new notifier was created.

◆ notifier_dead_event()

auto iox2::config::Event::notifier_dead_event ( ) && -> bb::Optional< size_t >

Defines the event id value that is emitted if a notifier was identified as dead.

◆ notifier_dropped_event()

auto iox2::config::Event::notifier_dropped_event ( ) && -> bb::Optional< size_t >

Defines the event id value that is emitted before a new notifier is dropped.

◆ set_deadline()

void iox2::config::Event::set_deadline ( bb::Optional< iox2::bb::Duration > deadline ) &&

Sets the deadline of the event service.

◆ set_event_id_max_value()

void iox2::config::Event::set_event_id_max_value ( size_t value ) &&

Set the largest event id supported by the event service.

◆ set_max_listeners()

void iox2::config::Event::set_max_listeners ( size_t value ) &&

Set the maximum amount of supported [Listener].

◆ set_max_nodes()

void iox2::config::Event::set_max_nodes ( size_t value ) &&

Set the maximum amount of supported [Node]s.

◆ set_max_notifiers()

void iox2::config::Event::set_max_notifiers ( size_t value ) &&

Set the maximum amount of supported [Notifier].

◆ set_notifier_created_event()

void iox2::config::Event::set_notifier_created_event ( bb::Optional< size_t > value ) &&

Sets the event id value that is emitted after a new notifier was created.

◆ set_notifier_dead_event()

void iox2::config::Event::set_notifier_dead_event ( bb::Optional< size_t > value ) &&

Sets the event id value that is emitted if a notifier was identified as dead.

◆ set_notifier_dropped_event()

void iox2::config::Event::set_notifier_dropped_event ( bb::Optional< size_t > value ) &&

Sets the event id value that is emitted before a new notifier is dropped.

Friends And Related Symbol Documentation

◆ Defaults

friend class Defaults

friend

Definition at line 251 of file config.hpp.

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

iox2/config.hpp

Public Member Functions

Friends