#include <static_config_publish_subscribe.hpp>

Public Member Functions
auto	max_nodes () const -> uint64_t

auto	max_publishers () const -> uint64_t
	Returns the maximum supported amount of [`Publisher`] ports.

auto	max_subscribers () const -> uint64_t
	Returns the maximum supported amount of [`Subscriber`] ports.

auto	history_size () const -> uint64_t
	Returns the maximum history size that can be requested on connect.

auto	subscriber_max_buffer_size () const -> uint64_t
	Returns the maximum supported buffer size for [`Subscriber`] port.

auto	subscriber_max_borrowed_samples () const -> uint64_t
	Returns how many [`Sample`]s a [`Subscriber`] port can borrow in parallel at most.

auto	has_safe_overflow () const -> bool

auto	message_type_details () const -> MessageTypeDetails
	Returns the type details of the [`Service`].

Friends
template<ServiceType , typename , typename >
class	PortFactoryPublishSubscribe

class	StaticConfig

Detailed Description

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

Definition at line 26 of file static_config_publish_subscribe.hpp.

Member Function Documentation

◆ has_safe_overflow()

auto iox2::StaticConfigPublishSubscribe::has_safe_overflow ( ) const -> bool

Returns true if the [Service] safely overflows, otherwise false. Safe overflow means that the [Publisher] will recycle the oldest [Sample] from the [Subscriber] when its buffer is full.

◆ history_size()

auto iox2::StaticConfigPublishSubscribe::history_size ( ) const -> uint64_t

Returns the maximum history size that can be requested on connect.

◆ max_nodes()

auto iox2::StaticConfigPublishSubscribe::max_nodes ( ) const -> uint64_t

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

◆ max_publishers()

auto iox2::StaticConfigPublishSubscribe::max_publishers ( ) const -> uint64_t

Returns the maximum supported amount of [Publisher] ports.

◆ max_subscribers()

auto iox2::StaticConfigPublishSubscribe::max_subscribers ( ) const -> uint64_t

Returns the maximum supported amount of [Subscriber] ports.

◆ message_type_details()

auto iox2::StaticConfigPublishSubscribe::message_type_details ( ) const -> MessageTypeDetails

Returns the type details of the [Service].

◆ subscriber_max_borrowed_samples()

auto iox2::StaticConfigPublishSubscribe::subscriber_max_borrowed_samples ( ) const -> uint64_t

Returns how many [Sample]s a [Subscriber] port can borrow in parallel at most.

◆ subscriber_max_buffer_size()

auto iox2::StaticConfigPublishSubscribe::subscriber_max_buffer_size ( ) const -> uint64_t

Returns the maximum supported buffer size for [Subscriber] port.

Friends And Related Symbol Documentation

◆ PortFactoryPublishSubscribe

template<ServiceType , typename , typename >

friend class PortFactoryPublishSubscribe

friend

Definition at line 57 of file static_config_publish_subscribe.hpp.

◆ StaticConfig

friend class StaticConfig