iox::popo::SubscriberOptions

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

Public Functions

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

Public Attributes

	Name
uint64_t	queueCapacity The size of the receiver queue where chunks are stored before they are passed to the user.
uint64_t	historyRequest The max number of chunks received after subscription if chunks are available.
iox::NodeName_t	nodeName The name of the node where the subscriber should belong to.
bool	subscribeOnCreate The option whether the subscriber shall try to subscribe when creating it.
QueueFullPolicy	queueFullPolicy The option whether the publisher should block when the subscriber queue is full.
bool	requiresPublisherHistorySupport Indicates whether to enforce history support of the publisher, i.e. require historyCapacity > 0 to be eligible to be connected.

Public Functions Documentation

function serialize

cxx::Serialization serialize() const

serialization of the SubscriberOptions

function deserialize

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

deserialization of the SubscriberOptions

Public Attributes Documentation

variable queueCapacity

uint64_t queueCapacity {SubscriberChunkQueueData_t::MAX_CAPACITY};

The size of the receiver queue where chunks are stored before they are passed to the user.

Attention: Depending on the underlying queue there can be a different overflow behavior

variable historyRequest

uint64_t historyRequest {0U};

The max number of chunks received after subscription if chunks are available.

variable nodeName

iox::NodeName_t nodeName {""};

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

variable subscribeOnCreate

bool subscribeOnCreate {true};

The option whether the subscriber shall try to subscribe when creating it.

variable queueFullPolicy

QueueFullPolicy queueFullPolicy {QueueFullPolicy::DISCARD_OLDEST_DATA};

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

variable requiresPublisherHistorySupport

bool requiresPublisherHistorySupport {false};

Indicates whether to enforce history support of the publisher, i.e. require historyCapacity > 0 to be eligible to be connected.

---

Updated on 2 April 2022 at 16:37:47 CEST