This struct is used to configure the client.
More...
#include <iceoryx_posh/popo/client_options.hpp>
|
static cxx::expected< ClientOptions, cxx::Serialization::Error > | deserialize (const cxx::Serialization &serialized) noexcept |
| deserialization of the ClientOptions
|
|
|
uint64_t | responseQueueCapacity {ClientChunkQueueData_t::MAX_CAPACITY} |
| The size of the response queue where chunks are stored before they are passed to the user. More...
|
|
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. More...
|
|
ConsumerTooSlowPolicy | serverTooSlowPolicy {ConsumerTooSlowPolicy::DISCARD_OLDEST_DATA} |
| The option whether the client should block when the request queue is full. More...
|
|
This struct is used to configure the client.
◆ operator==()
bool iox::popo::ClientOptions::operator== |
( |
const ClientOptions & |
rhs | ) |
const |
|
noexcept |
comparison operator
- Parameters
-
[in] | rhs | the right hand side of the comparison |
◆ 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} |
◆ serverTooSlowPolicy
ConsumerTooSlowPolicy iox::popo::ClientOptions::serverTooSlowPolicy {ConsumerTooSlowPolicy::DISCARD_OLDEST_DATA} |
The documentation for this struct was generated from the following file: