iox_client_options_t

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

Public Attributes

	Name
uint64_t	responseQueueCapacity size of the response queue
char	nodeName name of the node the client belongs to
bool	connectOnCreate Indicates if the client should be connected when created.
ENUM iox_QueueFullPolicy	responseQueueFullPolicy Sets whether the server blocks when the client response queue is full.
ENUM iox_ConsumerTooSlowPolicy	serverTooSlowPolicy Sets whether the client blocks when the server request queue is full.
uint64_t	initCheck this value will be set exclusively by iox_client_options_init and is not supposed to be modified otherwise

Public Attributes Documentation

variable responseQueueCapacity

uint64_t responseQueueCapacity;

size of the response queue

variable nodeName

char nodeName;

name of the node the client belongs to

variable connectOnCreate

bool connectOnCreate;

Indicates if the client should be connected when created.

variable responseQueueFullPolicy

ENUM iox_QueueFullPolicy responseQueueFullPolicy;

Sets whether the server blocks when the client response queue is full.

variable serverTooSlowPolicy

ENUM iox_ConsumerTooSlowPolicy serverTooSlowPolicy;

Sets whether the client blocks when the server request queue is full.

variable initCheck

uint64_t initCheck;

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

---

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