Struct iox_sub_options_t

• Defined in File subscriber.h

Struct Documentation

struct iox_sub_options_t

options to be set for a subscriber

Public Members

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

Note

nullptr indicates that the default node name is used

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