Skip to content

iox::popo::ClientOptions🔗

This struct is used to configure the client. #include <iceoryx_posh/popo/client_options.hpp>

Public Functions🔗

Name
cxx::Serialization serialize() const
serialization of the ClientOptions
bool operator==(const ClientOptions & rhs) const
comparison operator
cxx::expected< ClientOptions, cxx::Serialization::Error > deserialize(const cxx::Serialization & serialized)
deserialization of the ClientOptions

Public Attributes🔗

Name
uint64_t responseQueueCapacity
The size of the response queue where chunks are stored before they are passed to the user.
iox::NodeName_t nodeName
The name of the node where the client should belong to.
bool connectOnCreate
The option whether the client shall try to connect when creating it.
QueueFullPolicy responseQueueFullPolicy
The option whether the server should block when the response queue is full.
ConsumerTooSlowPolicy serverTooSlowPolicy
The option whether the client should block when the request queue is full.

Public Functions Documentation🔗

function serialize🔗

cxx::Serialization serialize() const

serialization of the ClientOptions

function operator==🔗

bool operator==(
    const ClientOptions & rhs
) const

comparison operator

Parameters:

  • rhs the right hand side of the comparison

function deserialize🔗

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

deserialization of the ClientOptions

Public Attributes Documentation🔗

variable responseQueueCapacity🔗

uint64_t responseQueueCapacity {ClientChunkQueueData_t::MAX_CAPACITY};

The size of the response 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

variable nodeName🔗

iox::NodeName_t nodeName {""};

The name of the node where the client should belong to.

variable connectOnCreate🔗

bool connectOnCreate {true};

The option whether the client shall try to connect when creating it.

variable responseQueueFullPolicy🔗

QueueFullPolicy responseQueueFullPolicy {QueueFullPolicy::DISCARD_OLDEST_DATA};

The option whether the server should block when the response queue is full.

Note: Corresponds with ServerOptions::clientTooSlowPolicy

variable serverTooSlowPolicy🔗

ConsumerTooSlowPolicy serverTooSlowPolicy {ConsumerTooSlowPolicy::DISCARD_OLDEST_DATA};

The option whether the client should block when the request queue is full.

Note: Corresponds with ServerOptions::requestQueueFullPolicy

Updated on 18 December 2023 at 13:02:35 CET