Skip to content

iox::popo::ServerOptions🔗

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

Public Functions🔗

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

Public Attributes🔗

Name
uint64_t requestQueueCapacity
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
The option whether the server should already be offered when creating it.
QueueFullPolicy requestQueueFullPolicy
The option whether the client should block when the request queue is full.
ConsumerTooSlowPolicy clientTooSlowPolicy
The option whether the server should block when the response queue is full.

Public Functions Documentation🔗

function serialize🔗

cxx::Serialization serialize() const

serialization of the ServerOptions

function operator==🔗

bool operator==(
    const ServerOptions & rhs
) const

comparison operator

Parameters:

  • rhs the right hand side of the comparison

function deserialize🔗

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

deserialization of the ServerOptions

Public Attributes Documentation🔗

variable requestQueueCapacity🔗

uint64_t 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

variable nodeName🔗

iox::NodeName_t nodeName {""};

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

variable offerOnCreate🔗

bool offerOnCreate {true};

The option whether the server should already be offered when creating it.

variable requestQueueFullPolicy🔗

QueueFullPolicy requestQueueFullPolicy {QueueFullPolicy::DISCARD_OLDEST_DATA};

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

Note: Corresponds with ClientOptions::serverTooSlowPolicy

variable clientTooSlowPolicy🔗

ConsumerTooSlowPolicy clientTooSlowPolicy {ConsumerTooSlowPolicy::DISCARD_OLDEST_DATA};

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

Note: Corresponds with ClientOptions::responseQueueFullPolicy

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