Struct ServerOptions

• Defined in File server_options.hpp

Struct Documentation

struct ServerOptions

This struct is used to configure the server.

Public Functions

cxx::Serialization serialize() const noexcept

serialization of the ServerOptions

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

comparison operator

Parameters:

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

Public Members

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

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.

Note

Corresponds with ClientOptions::serverTooSlowPolicy

ConsumerTooSlowPolicy clientTooSlowPolicy = {ConsumerTooSlowPolicy::DISCARD_OLDEST_DATA}

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

Note

Corresponds with ClientOptions::responseQueueFullPolicy

Public Static Functions

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

deserialization of the ServerOptions