iceoryx_posh 2.0.3
subscriber_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_SUBSCRIBER_OPTIONS_HPP
18#define IOX_POSH_POPO_SUBSCRIBER_OPTIONS_HPP
19
20#include "iceoryx_posh/internal/popo/ports/pub_sub_port_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{
36 uint64_t queueCapacity{SubscriberChunkQueueData_t::MAX_CAPACITY};
37
39 uint64_t historyRequest{0U};
40
42 iox::NodeName_t nodeName{""};
43
46
48 QueueFullPolicy queueFullPolicy{QueueFullPolicy::DISCARD_OLDEST_DATA};
49
53
55 cxx::Serialization serialize() const noexcept;
57 static cxx::expected<SubscriberOptions, cxx::Serialization::Error>
58 deserialize(const cxx::Serialization& serialized) noexcept;
59};
60
61} // namespace popo
62} // namespace iox
63#endif // IOX_POSH_POPO_SUBSCRIBER_OPTIONS_HPP
This struct is used to configure the subscriber.
Definition: subscriber_options.hpp:33
bool requiresPublisherHistorySupport
Indicates whether to enforce history support of the publisher, i.e. require historyCapacity > 0 to be...
Definition: subscriber_options.hpp:52
iox::NodeName_t nodeName
The name of the node where the subscriber should belong to.
Definition: subscriber_options.hpp:42
static cxx::expected< SubscriberOptions, cxx::Serialization::Error > deserialize(const cxx::Serialization &serialized) noexcept
deserialization of the SubscriberOptions
bool subscribeOnCreate
The option whether the subscriber shall try to subscribe when creating it.
Definition: subscriber_options.hpp:45
uint64_t historyRequest
The max number of chunks received after subscription if chunks are available.
Definition: subscriber_options.hpp:39
QueueFullPolicy queueFullPolicy
The option whether the publisher should block when the subscriber queue is full.
Definition: subscriber_options.hpp:48
uint64_t queueCapacity
The size of the receiver queue where chunks are stored before they are passed to the user.
Definition: subscriber_options.hpp:36
cxx::Serialization serialize() const noexcept
serialization of the SubscriberOptions