iceoryx_doc  1.0.1
subscriber_port_data.hpp
1 // Copyright (c) 2020 by Robert Bosch GmbH. All rights reserved.
2 // Copyright (c) 2021 by Apex.AI Inc. All rights reserved.
3 //
4 // Licensed under the Apache License, Version 2.0 (the "License");
5 // you may not use this file except in compliance with the License.
6 // You may obtain a copy of the License at
7 //
8 // http://www.apache.org/licenses/LICENSE-2.0
9 //
10 // Unless required by applicable law or agreed to in writing, software
11 // distributed under the License is distributed on an "AS IS" BASIS,
12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 // See the License for the specific language governing permissions and
14 // limitations under the License.
15 //
16 // SPDX-License-Identifier: Apache-2.0
17 
18 #ifndef IOX_POSH_POPO_PORTS_SUBSCRIBER_PORT_DATA_HPP
19 #define IOX_POSH_POPO_PORTS_SUBSCRIBER_PORT_DATA_HPP
20 
21 #include "iceoryx_posh/capro/service_description.hpp"
22 #include "iceoryx_posh/iceoryx_posh_types.hpp"
23 #include "iceoryx_posh/internal/popo/building_blocks/chunk_receiver_data.hpp"
24 #include "iceoryx_posh/internal/popo/building_blocks/locking_policy.hpp"
25 #include "iceoryx_posh/internal/popo/ports/base_port_data.hpp"
26 #include "iceoryx_utils/cxx/variant_queue.hpp"
27 
28 #include <atomic>
29 
30 namespace iox
31 {
32 namespace popo
33 {
34 struct SubscriberOptions;
35 
37 {
38  SubscriberPortData(const capro::ServiceDescription& serviceDescription,
39  const RuntimeName_t& runtimeName,
40  cxx::VariantQueueTypes queueType,
41  const SubscriberOptions& subscriberOptions,
42  const mepoo::MemoryInfo& memoryInfo = mepoo::MemoryInfo()) noexcept;
43 
46 
47  ChunkReceiverData_t m_chunkReceiverData;
48  const uint64_t m_historyRequest;
49  std::atomic_bool m_subscribeRequested{false};
50  std::atomic<SubscribeState> m_subscriptionState{SubscribeState::NOT_SUBSCRIBED};
51 };
52 
53 } // namespace popo
54 } // namespace iox
55 
56 #endif // IOX_POSH_POPO_PORTS_SUBSCRIBER_PORT_DATA_HPP
class for the identification of a communication event including information on the service,...
Definition: service_description.hpp:86
Definition: service_description.hpp:29
Stores properties of the memory to be used when we distinguish between different types of memory on e...
Definition: memory_info.hpp:28
Defines different base port data.
Definition: base_port_data.hpp:34
Definition: chunk_queue_data.hpp:35
This struct is used to configure the subscriber.
Definition: subscriber_options.hpp:31
Definition: subscriber_port_data.hpp:37