iox::popo::PublisherOptions

This struct is used to configure the publisher. #include <iceoryx_posh/popo/publisher_options.hpp>

Public Functions

	Name
cxx::Serialization	serialize() const serialization of the PublisherOptions
cxx::expected< PublisherOptions, cxx::Serialization::Error >	deserialize(const cxx::Serialization & serialized) deserialization of the PublisherOptions

Public Attributes

	Name
uint64_t	historyCapacity The size of the history chunk queue.
iox::NodeName_t	nodeName The name of the node where the publisher should belong to.
bool	offerOnCreate The option whether the publisher should already be offered when creating it.
ConsumerTooSlowPolicy	subscriberTooSlowPolicy The option whether the publisher should block when the subscriber queue is full.

Public Functions Documentation

function serialize

cxx::Serialization serialize() const

serialization of the PublisherOptions

function deserialize

static cxx::expected< PublisherOptions, cxx::Serialization::Error > deserialize(
    const cxx::Serialization & serialized
)

deserialization of the PublisherOptions

Public Attributes Documentation

variable historyCapacity

uint64_t historyCapacity {0U};

The size of the history chunk queue.

variable nodeName

iox::NodeName_t nodeName {""};

The name of the node where the publisher should belong to.

variable offerOnCreate

bool offerOnCreate {true};

The option whether the publisher should already be offered when creating it.

variable subscriberTooSlowPolicy

ConsumerTooSlowPolicy subscriberTooSlowPolicy {ConsumerTooSlowPolicy::DISCARD_OLDEST_DATA};

The option whether the publisher should block when the subscriber queue is full.

---

Updated on 18 December 2023 at 13:11:43 CET