RTC Toolkit 6.0.0
Loading...
Searching...
No Matches
ddsPub.hpp
Go to the documentation of this file.
1
11#ifndef RTCTK_COMPONENTFRAMEWORK_DATAPATH_DDSPUB_HPP
12#define RTCTK_COMPONENTFRAMEWORK_DATAPATH_DDSPUB_HPP
13
14#include <list>
15#include <memory>
17
19
20using namespace std::chrono_literals;
21
28 std::string topic_name;
29 std::shared_ptr<DataWriterListener> listener;
30
31 DdsWriterParams(const std::string& tn, std::shared_ptr<DataWriterListener> l)
32 : topic_name(tn), listener(std::move(l)) {
33 }
34
35 explicit DdsWriterParams(const std::string& tn) : topic_name(tn) {
36 }
37};
38
46class DdsPub : public Dds {
47 // cppcheck-suppress-begin unusedStructMember
48
49 Publisher* m_publisher = nullptr;
50 std::vector<DataWriter*> m_data_writers;
51 std::vector<std::shared_ptr<DataWriterListener>> m_listeners;
52
53 // cppcheck-suppress-end unusedStructMember
54
55public:
67 explicit DdsPub(const std::string& qos_file,
68 const std::string& qos_profile = DEFAULT_QOS_PROFILE,
69 DomainId_t domain_id = DEFAULT_DOMAIN_ID,
70 const std::string& participant_name = "");
71 ~DdsPub() override;
72
77 void CreatePublisher();
78
82 void DestroyPublisher();
83
91 DataWriter*
92 CreateDataWriter(Topic* topic, std::shared_ptr<DataWriterListener> listener = nullptr);
93
103 void DestroyDataWriter(DataWriter* dw,
104 bool to_be_removed = true,
105 std::chrono::milliseconds wait_acks_timeout = 5000ms);
106
111 void CreateDataWriters();
112
121 void DestroyAllDataWriters(std::chrono::milliseconds wait_acks_timeout = 5000ms);
122
128 void CreateManyDataWriters(const std::vector<DdsWriterParams>& topics_listeners);
129
135 void CreateManyDataWriters(const std::vector<std::string>& topic_names);
136
140 // Not using virtual methods on purpose because DumpDDSstatistics is called in the destructor.
141 // cppcheck-suppress duplInheritedMember
142 void DumpDDSstatistics();
143
147 std::vector<DataWriter*>& GetDataWriters() {
148 return m_data_writers;
149 }
150
157 void WaitForAcks(DataWriter* dw, std::chrono::milliseconds wait_acks_timeout = 5000ms);
158};
159
160} // namespace rtctk::componentFramework
161
162#endif // RTCTK_COMPONENTFRAMEWORK_DATAPATH_DDSPUB_HPP
void DumpDDSstatistics()
Dumps / logs varios DDS statistic like NACks, ACKs, ... for each DDS writer.
Definition ddsPub.cpp:244
void DestroyDataWriter(DataWriter *dw, bool to_be_removed=true, std::chrono::milliseconds wait_acks_timeout=5000ms)
Destroys DDS data writer, and also its listener.
Definition ddsPub.cpp:145
void CreateDataWriters()
Creates DDS Data Writer for all DDS topics.
Definition ddsPub.cpp:229
void WaitForAcks(DataWriter *dw, std::chrono::milliseconds wait_acks_timeout=5000ms)
Wait for ACKs for the given DDS Data Writer.
Definition ddsPub.cpp:249
void CreatePublisher()
Creates DDS publisher.
Definition ddsPub.cpp:43
void CreateManyDataWriters(const std::vector< DdsWriterParams > &topics_listeners)
create DDS topics and DDS writers for the given list (vector) of topic names and rtctk::componentFram...
Definition ddsPub.cpp:189
void DestroyPublisher()
Destroys DDS publisher.
Definition ddsPub.cpp:76
DdsPub(const std::string &qos_file, const std::string &qos_profile=DEFAULT_QOS_PROFILE, DomainId_t domain_id=DEFAULT_DOMAIN_ID, const std::string &participant_name="")
DDS Publsiher class that takes care for handling all DDS entities to publish samples.
Definition ddsPub.cpp:25
~DdsPub() override
Definition ddsPub.cpp:34
DataWriter * CreateDataWriter(Topic *topic, std::shared_ptr< DataWriterListener > listener=nullptr)
Creates DDS writer for particular topic for topic of type: rtctk::AgnosticTopic.
Definition ddsPub.cpp:93
std::vector< DataWriter * > & GetDataWriters()
returns vector of all DDS Data writers
Definition ddsPub.hpp:147
void DestroyAllDataWriters(std::chrono::milliseconds wait_acks_timeout=5000ms)
Destroys DDS Data Writer for all DDS topics.
Definition ddsPub.cpp:218
static const DomainId_t DEFAULT_DOMAIN_ID
default Domain Id for different DDS
Definition dds.hpp:173
static const std::string DEFAULT_QOS_PROFILE
default profile name for different DDS QoSs
Definition dds.hpp:167
Dds(const std::string &qos_file, const std::string &qos_profile=DEFAULT_QOS_PROFILE, DomainId_t domain_id=DEFAULT_DOMAIN_ID, const std::string &participant_name="")
Constructor for Base class for both DDS Publisher and DDS Subscriber.
Definition dds.cpp:24
Declares common DDS class.
Definition commandReplier.cpp:21
Definition ddsSub.hpp:155
DdsWriterParams(const std::string &tn, std::shared_ptr< DataWriterListener > l)
Definition ddsPub.hpp:31
std::string topic_name
Definition ddsPub.hpp:28
std::shared_ptr< DataWriterListener > listener
Definition ddsPub.hpp:29
DdsWriterParams(const std::string &tn)
Definition ddsPub.hpp:35