iceoryx_posh 2.0.3
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
iox::popo::SubscriberOptions Struct Reference

This struct is used to configure the subscriber. More...

#include <iceoryx_posh/popo/subscriber_options.hpp>

Public Member Functions

cxx::Serialization serialize () const noexcept
 serialization of the SubscriberOptions
 

Static Public Member Functions

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

Public Attributes

uint64_t queueCapacity {SubscriberChunkQueueData_t::MAX_CAPACITY}
 The size of the receiver queue where chunks are stored before they are passed to the user. More...
 
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.
 

Detailed Description

This struct is used to configure the subscriber.

Member Data Documentation

◆ queueCapacity

uint64_t iox::popo::SubscriberOptions::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

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