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

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

#include <iceoryx_posh/popo/server_options.hpp>

Public Member Functions

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

Static Public Member Functions

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

Public Attributes

uint64_t requestQueueCapacity {ServerChunkQueueData_t::MAX_CAPACITY}
 The size of the request queue where chunks are stored before they are passed to the user.
 
iox::NodeName_t nodeName {""}
 The name of the node where the server should belong to.
 
bool offerOnCreate {true}
 The option whether the server should already be offered when creating it.
 
QueueFullPolicy requestQueueFullPolicy {QueueFullPolicy::DISCARD_OLDEST_DATA}
 The option whether the client should block when the request queue is full.
 
ConsumerTooSlowPolicy clientTooSlowPolicy {ConsumerTooSlowPolicy::DISCARD_OLDEST_DATA}
 The option whether the server should block when the response queue is full.
 

Detailed Description

This struct is used to configure the server.

Member Function Documentation

◆ operator==()

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

comparison operator

Parameters
[in]rhsthe right hand side of the comparison

Member Data Documentation

◆ clientTooSlowPolicy

ConsumerTooSlowPolicy iox::popo::ServerOptions::clientTooSlowPolicy {ConsumerTooSlowPolicy::DISCARD_OLDEST_DATA}

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

Note
Corresponds with ClientOptions::responseQueueFullPolicy

◆ requestQueueCapacity

uint64_t iox::popo::ServerOptions::requestQueueCapacity {ServerChunkQueueData_t::MAX_CAPACITY}

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

◆ requestQueueFullPolicy

QueueFullPolicy iox::popo::ServerOptions::requestQueueFullPolicy {QueueFullPolicy::DISCARD_OLDEST_DATA}

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

Note
Corresponds with ClientOptions::serverTooSlowPolicy

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