Struct ClientOptions

• Defined in File client_options.hpp

Struct Documentation

struct ClientOptions

This struct is used to configure the client.

Public Functions

cxx::Serialization serialize() const noexcept

serialization of the ClientOptions

bool operator==(const ClientOptions &rhs) const noexcept

comparison operator

Parameters:

rhs – [in] the right hand side of the comparison

Public Members

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

iox::NodeName_t nodeName = {""}

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

bool connectOnCreate = {true}

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

QueueFullPolicy responseQueueFullPolicy = {QueueFullPolicy::DISCARD_OLDEST_DATA}

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

Note

Corresponds with ServerOptions::clientTooSlowPolicy

ConsumerTooSlowPolicy serverTooSlowPolicy = {ConsumerTooSlowPolicy::DISCARD_OLDEST_DATA}

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

Note

Corresponds with ServerOptions::requestQueueFullPolicy

Public Static Functions

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

deserialization of the ClientOptions