iceoryx_posh 2.0.5
Loading...
Searching...
No Matches
server_options.hpp
1// Copyright (c) 2021 - 2022 by Apex.AI Inc. All rights reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14//
15// SPDX-License-Identifier: Apache-2.0
16
17#ifndef IOX_POSH_POPO_SERVER_OPTIONS_HPP
18#define IOX_POSH_POPO_SERVER_OPTIONS_HPP
19
20#include "iceoryx_posh/internal/popo/ports/client_server_port_types.hpp"
21#include "iceoryx_posh/popo/port_queue_policies.hpp"
22
23#include "iceoryx_hoofs/cxx/serialization.hpp"
24
25#include <cstdint>
26
27namespace iox
28{
29namespace popo
30{
33{
36 uint64_t requestQueueCapacity{ServerChunkQueueData_t::MAX_CAPACITY};
37
39 iox::NodeName_t nodeName{""};
40
42 bool offerOnCreate{true};
43
46 QueueFullPolicy requestQueueFullPolicy{QueueFullPolicy::DISCARD_OLDEST_DATA};
47
50 ConsumerTooSlowPolicy clientTooSlowPolicy{ConsumerTooSlowPolicy::DISCARD_OLDEST_DATA};
51
53 cxx::Serialization serialize() const noexcept;
55 static cxx::expected<ServerOptions, cxx::Serialization::Error>
57
61};
62
63} // namespace popo
64} // namespace iox
65#endif // IOX_POSH_POPO_CLIENT_OPTIONS_HPP
the struct describes a callback with a user defined type which can be attached to a WaitSet or a List...
Definition notification_callback.hpp:58
This struct is used to configure the server.
Definition server_options.hpp:33
cxx::Serialization serialize() const noexcept
serialization of the ServerOptions
static cxx::expected< ServerOptions, cxx::Serialization::Error > deserialize(const cxx::Serialization &serialized) noexcept
deserialization of the ServerOptions
bool offerOnCreate
The option whether the server should already be offered when creating it.
Definition server_options.hpp:42
iox::NodeName_t nodeName
The name of the node where the server should belong to.
Definition server_options.hpp:39
ConsumerTooSlowPolicy clientTooSlowPolicy
The option whether the server should block when the response queue is full.
Definition server_options.hpp:50
QueueFullPolicy requestQueueFullPolicy
The option whether the client should block when the request queue is full.
Definition server_options.hpp:46
uint64_t requestQueueCapacity
The size of the request queue where chunks are stored before they are passed to the user.
Definition server_options.hpp:36