Skip to content

iox_sub_options_t🔗

options to be set for a subscriber #include <iceoryx_binding_c/subscriber.h>

Public Attributes🔗

Name
uint64_t queueCapacity
size of the history chunk queue
uint64_t historyRequest
number of chunks received after subscription if chunks are available
const char * nodeName
name of the node the subscriber belongs to
bool subscribeOnCreate
The option whether the subscriber shall try to subscribe when creating it.
ENUM iox_QueueFullPolicy queueFullPolicy
describes whether a publisher blocks when subscriber queue is full
bool requirePublisherHistorySupport
Indicates whether we require the publisher to have historyCapacity > 0. If true and the condition is not met (i.e. historyCapacity = 0), the subscriber will not be connected to the publisher.
uint64_t initCheck
this value will be set exclusively by iox_sub_options_init and is not supposed to be modified otherwise

Public Attributes Documentation🔗

variable queueCapacity🔗

uint64_t queueCapacity;

size of the history chunk queue

variable historyRequest🔗

uint64_t historyRequest;

number of chunks received after subscription if chunks are available

variable nodeName🔗

const char * nodeName;

name of the node the subscriber belongs to

Note: nullptr indicates that the default node name is used

variable subscribeOnCreate🔗

bool subscribeOnCreate;

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

variable queueFullPolicy🔗

ENUM iox_QueueFullPolicy queueFullPolicy;

describes whether a publisher blocks when subscriber queue is full

variable requirePublisherHistorySupport🔗

bool requirePublisherHistorySupport;

Indicates whether we require the publisher to have historyCapacity > 0. If true and the condition is not met (i.e. historyCapacity = 0), the subscriber will not be connected to the publisher.

variable initCheck🔗

uint64_t initCheck;

this value will be set exclusively by iox_sub_options_init and is not supposed to be modified otherwise


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