iceoryx_doc  1.0.1
subscriber_options.hpp
1 // Copyright (c) 2020 - 2021 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/subscriber_port_data.hpp"
21 #include "port_queue_policies.hpp"
22 
23 #include <cstdint>
24 
25 namespace iox
26 {
27 namespace popo
28 {
31 {
34  uint64_t queueCapacity{SubscriberPortData::ChunkQueueData_t::MAX_CAPACITY};
35 
37  uint64_t historyRequest{0U};
38 
40  iox::NodeName_t nodeName{""};
41 
43  bool subscribeOnCreate{true};
44 
46  QueueFullPolicy queueFullPolicy{QueueFullPolicy::DISCARD_OLDEST_DATA};
47 };
48 
49 } // namespace popo
50 } // namespace iox
51 #endif // IOX_POSH_POPO_SUBSCRIBER_OPTIONS_HPP
Definition: service_description.hpp:29
This struct is used to configure the subscriber.
Definition: subscriber_options.hpp:31
iox::NodeName_t nodeName
The name of the node where the subscriber should belong to.
Definition: subscriber_options.hpp:40
bool subscribeOnCreate
The option whether the subscriber shall try to subscribe when creating it.
Definition: subscriber_options.hpp:43
uint64_t historyRequest
The max number of chunks received after subscription if chunks are available.
Definition: subscriber_options.hpp:37
QueueFullPolicy queueFullPolicy
The option whether the publisher should block when the subscriber queue is full.
Definition: subscriber_options.hpp:46
uint64_t queueCapacity
The size of the receiver queue where chunks are stored before they are passed to the user.
Definition: subscriber_options.hpp:34