Struct SubscriberOptions

Struct Documentation

struct SubscriberOptions

This struct is used to configure the subscriber.

Public Functions

cxx::Serialization serialize() const noexcept

serialization of the SubscriberOptions

Public Members

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

uint64_t historyRequest = {0U}

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 = {true}

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

QueueFullPolicy queueFullPolicy = {QueueFullPolicy::DISCARD_OLDEST_DATA}

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

bool requiresPublisherHistorySupport = {false}

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

Public Static Functions

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

deserialization of the SubscriberOptions