iox2::config::PublishSubscribe Class Reference

#include <config.hpp>

Public Member Functions
auto	max_subscribers () &&-> size_t
	The maximum amount of supported [Subscriber]s.
void	set_max_subscribers (size_t value) &&
	Set the maximum amount of supported [Subscriber]s.
auto	max_publishers () &&-> size_t
	The maximum amount of supported [Publisher]s.
void	set_max_publishers (size_t value) &&
	Set the maximum amount of supported [Publisher]s.
auto	max_nodes () &&-> size_t
void	set_max_nodes (size_t value) &&
	Set the maximum amount of supported [Node]s.
auto	subscriber_max_buffer_size () &&-> size_t
	The maximum buffer size a [Subscriber] can have.
void	set_subscriber_max_buffer_size (size_t value) &&
	Set the maximum buffer size a [Subscriber] can have.
auto	subscriber_max_borrowed_samples () &&-> size_t
	The maximum amount of [Sample]s a [Subscriber] can hold at the same time.
void	set_subscriber_max_borrowed_samples (size_t value) &&
	Set the maximum amount of [Sample]s a [Subscriber] can hold at the same time.
auto	publisher_max_loaned_samples () &&-> size_t
	The maximum amount of [SampleMut]s a [Publisher] can loan at the same time.
void	set_publisher_max_loaned_samples (size_t value) &&
	The maximum amount of [SampleMut]s a [Publisher] can loan at the same time.
auto	publisher_history_size () &&-> size_t
	The maximum history size a [Subscriber] can request from a [Publisher].
void	set_publisher_history_size (size_t value) &&
	Set the maximum history size a [Subscriber] can request from a [Publisher].
auto	enable_safe_overflow () &&-> bool
void	set_enable_safe_overflow (bool value) &&
	Enables/disables safe overflow.
auto	backpressure_strategy () &&-> BackpressureStrategy
void	set_backpressure_strategy (BackpressureStrategy value) &&
	Define the backpressure strategy.
auto	subscriber_expired_connection_buffer () &&-> size_t
void	set_subscriber_expired_connection_buffer (size_t value) &&
	Set the expired connection buffer size.

Friends
class	Defaults

Detailed Description

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

Definition at line 152 of file config.hpp.

Member Function Documentation

backpressure_strategy()

auto iox2::config::PublishSubscribe::backpressure_strategy

(

)

&& -> BackpressureStrategy

If safe overflow is deactivated it defines the deliver strategy of the [Publisher] when the [Subscriber]s buffer is full.

enable_safe_overflow()

auto iox2::config::PublishSubscribe::enable_safe_overflow

(

)

&& -> bool

Defines how the [Subscriber] buffer behaves when it is full. When safe overflow is activated, the [Publisher] will replace the oldest [Sample] with the newest one.

max_nodes()

auto iox2::config::PublishSubscribe::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_publishers()

auto iox2::config::PublishSubscribe::max_publishers

(

)

&& -> size_t

The maximum amount of supported [Publisher]s.

max_subscribers()

auto iox2::config::PublishSubscribe::max_subscribers

(

)

&& -> size_t

The maximum amount of supported [Subscriber]s.

publisher_history_size()

auto iox2::config::PublishSubscribe::publisher_history_size

(

)

&& -> size_t

The maximum history size a [Subscriber] can request from a [Publisher].

publisher_max_loaned_samples()

auto iox2::config::PublishSubscribe::publisher_max_loaned_samples

(

)

&& -> size_t

The maximum amount of [SampleMut]s a [Publisher] can loan at the same time.

set_backpressure_strategy()

void iox2::config::PublishSubscribe::set_backpressure_strategy

(

BackpressureStrategy

value

)

&&

Define the backpressure strategy.

set_enable_safe_overflow()

void iox2::config::PublishSubscribe::set_enable_safe_overflow

(

bool

value

)

&&

Enables/disables safe overflow.

set_max_nodes()

void iox2::config::PublishSubscribe::set_max_nodes

(

size_t

value

)

&&

Set the maximum amount of supported [Node]s.

set_max_publishers()

void iox2::config::PublishSubscribe::set_max_publishers

(

size_t

value

)

&&

Set the maximum amount of supported [Publisher]s.

set_max_subscribers()

void iox2::config::PublishSubscribe::set_max_subscribers

(

size_t

value

)

&&

Set the maximum amount of supported [Subscriber]s.

set_publisher_history_size()

void iox2::config::PublishSubscribe::set_publisher_history_size

(

size_t

value

)

&&

Set the maximum history size a [Subscriber] can request from a [Publisher].

set_publisher_max_loaned_samples()

void iox2::config::PublishSubscribe::set_publisher_max_loaned_samples

(

size_t

value

)

&&

The maximum amount of [SampleMut]s a [Publisher] can loan at the same time.

set_subscriber_expired_connection_buffer()

void iox2::config::PublishSubscribe::set_subscriber_expired_connection_buffer

(

size_t

value

)

&&

Set the expired connection buffer size.

set_subscriber_max_borrowed_samples()

void iox2::config::PublishSubscribe::set_subscriber_max_borrowed_samples

(

size_t

value

)

&&

Set the maximum amount of [Sample]s a [Subscriber] can hold at the same time.

set_subscriber_max_buffer_size()

void iox2::config::PublishSubscribe::set_subscriber_max_buffer_size

(

size_t

value

)

&&

Set the maximum buffer size a [Subscriber] can have.

subscriber_expired_connection_buffer()

auto iox2::config::PublishSubscribe::subscriber_expired_connection_buffer

(

)

&& -> size_t

Defines the size of the internal [Subscriber] buffer that contains expired connections. An connection is expired when the [Publisher] disconnected from a service and the connection still contains unconsumed [Sample]s.

subscriber_max_borrowed_samples()

auto iox2::config::PublishSubscribe::subscriber_max_borrowed_samples

(

)

&& -> size_t

The maximum amount of [Sample]s a [Subscriber] can hold at the same time.

subscriber_max_buffer_size()

auto iox2::config::PublishSubscribe::subscriber_max_buffer_size

(

)

&& -> size_t

The maximum buffer size a [Subscriber] can have.

Friends And Related Symbol Documentation

Defaults

friend class Defaults

friend

Definition at line 204 of file config.hpp.

---

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

• iox2/config.hpp