iceoryx_posh 2.0.5
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
iox::popo::ClientOptions Struct Reference

This struct is used to configure the client. More...

#include <iceoryx_posh/popo/client_options.hpp>

Public Member Functions

cxx::Serialization serialize () const noexcept
 serialization of the ClientOptions
 
bool operator== (const ClientOptions &rhs) const noexcept
 comparison operator
 

Static Public Member Functions

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

Public Attributes

uint64_t responseQueueCapacity {ClientChunkQueueData_t::MAX_CAPACITY}
 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 {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.
 
ConsumerTooSlowPolicy serverTooSlowPolicy {ConsumerTooSlowPolicy::DISCARD_OLDEST_DATA}
 The option whether the client should block when the request queue is full.
 

Detailed Description

This struct is used to configure the client.

Member Function Documentation

◆ operator==()

bool iox::popo::ClientOptions::operator== ( const ClientOptions rhs) const
noexcept

comparison operator

Parameters
[in]rhsthe right hand side of the comparison

Member Data Documentation

◆ responseQueueCapacity

uint64_t iox::popo::ClientOptions::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

◆ responseQueueFullPolicy

QueueFullPolicy iox::popo::ClientOptions::responseQueueFullPolicy {QueueFullPolicy::DISCARD_OLDEST_DATA}

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

Note
Corresponds with ServerOptions::clientTooSlowPolicy

◆ serverTooSlowPolicy

ConsumerTooSlowPolicy iox::popo::ClientOptions::serverTooSlowPolicy {ConsumerTooSlowPolicy::DISCARD_OLDEST_DATA}

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

Note
Corresponds with ServerOptions::requestQueueFullPolicy

The documentation for this struct was generated from the following file: