iceoryx_posh 2.0.3
publisher_options.hpp
1// Copyright (c) 2020 - 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_PUBLISHER_OPTIONS_HPP
18#define IOX_POSH_POPO_PUBLISHER_OPTIONS_HPP
19
20#include "iceoryx_posh/iceoryx_posh_types.hpp"
21#include "port_queue_policies.hpp"
22
23#include "iceoryx_hoofs/cxx/serialization.hpp"
24
25#include <cstdint>
26
27namespace iox
28{
29namespace popo
30{
33{
35 uint64_t historyCapacity{0U};
36
38 iox::NodeName_t nodeName{""};
39
41 bool offerOnCreate{true};
42
44 ConsumerTooSlowPolicy subscriberTooSlowPolicy{ConsumerTooSlowPolicy::DISCARD_OLDEST_DATA};
45
47 cxx::Serialization serialize() const noexcept;
49 static cxx::expected<PublisherOptions, cxx::Serialization::Error>
50 deserialize(const cxx::Serialization& serialized) noexcept;
51};
52
53} // namespace popo
54} // namespace iox
55#endif // IOX_POSH_POPO_PUBLISHER_OPTIONS_HPP
This struct is used to configure the publisher.
Definition: publisher_options.hpp:33
iox::NodeName_t nodeName
The name of the node where the publisher should belong to.
Definition: publisher_options.hpp:38
static cxx::expected< PublisherOptions, cxx::Serialization::Error > deserialize(const cxx::Serialization &serialized) noexcept
deserialization of the PublisherOptions
uint64_t historyCapacity
The size of the history chunk queue.
Definition: publisher_options.hpp:35
cxx::Serialization serialize() const noexcept
serialization of the PublisherOptions
bool offerOnCreate
The option whether the publisher should already be offered when creating it.
Definition: publisher_options.hpp:41
ConsumerTooSlowPolicy subscriberTooSlowPolicy
The option whether the publisher should block when the subscriber queue is full.
Definition: publisher_options.hpp:44