Remove WriterProxyData from public APIs (#5052)

* Refs #21239. Empty skeletons for converter methods. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #21239. Refactor BuiltinTopicKey_t. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #21301. Rename RTPS callback to `on_writer_discovery`. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #21301. Split callback in reason + info. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #21301. Remove unused PDP method. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #21301. Refactor PublicationBuiltinTopicData. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #21301. Implement conversion method. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #21301. Refactor matched_writer_add. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #21301. Add guid to PublicationBuiltinTopicData. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #21301. Add type_information to PublicationBuiltinTopicData. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #21301. Use PublicationBuiltinTopicData on participant listeners. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #21301. Use PublicationBuiltinTopicData on fill_discovery_data_from_cdr_message. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #21301. Additional fields on PublicationBuiltinTopicData. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #21301. Move `WriterProxyData.hpp` to src. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #21301. Additional refactor on matched_writer_add. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #21301. Uncrustify. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #21301. Rename internal method to `matched_writer_add_edp`. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #21301. Refactor on ReaderListener. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #21301. Remove reference on doxygen comment. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #21301. Add `participant_guid` on PublicationBuiltinTopicData. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #21301. Fix build without security. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #21301. Add missing groups to `doxygen_modules.hpp`. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #21301. Rename enum to `WriterDiscoveryStatus`. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #21301. Rename header to `WriterDiscoveryStatus.hpp`. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #21301. Use `fastcdr::string_255`. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #21301. Uncrustify. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Update versions.md Signed-off-by: Miguel Company <miguelcompany@eprosima.com> --------- Signed-off-by: Miguel Company <miguelcompany@eprosima.com>
eProsima · Jul 17, 2024 · b0eb813 · b0eb813
1 parent 775e4c4
commit b0eb813
Show file tree

Hide file tree

Showing 101 changed files with 958 additions and 478 deletions.
diff --git a/examples/cpp/xtypes/SubscriberApp.cpp b/examples/cpp/xtypes/SubscriberApp.cpp
@@ -190,26 +190,27 @@ void SubscriberApp::on_data_available(
 
 void SubscriberApp::on_data_writer_discovery(
         DomainParticipant* /*participant*/,
-        eprosima::fastdds::rtps::WriterDiscoveryInfo&& info,
+        eprosima::fastdds::rtps::WriterDiscoveryStatus /*reason*/,
+        const eprosima::fastdds::dds::PublicationBuiltinTopicData& info,
         bool& should_be_ignored)
 {
     // We don't want to ignore the writer
     should_be_ignored = false;
 
     // Check if the discovered topic is the one we are interested in
-    if (topic_name_ == info.info.topicName().to_string())
+    if (topic_name_ == info.topic_name.to_string())
     {
         // Get remote type information and use it to retrieve the type object
-        auto type_info = info.info.type_information().type_information;
+        auto type_info = info.type_information.type_information;
         auto type_id = type_info.complete().typeid_with_size().type_id();
 
         if (RETCODE_OK != DomainParticipantFactory::get_instance()->type_object_registry().get_type_object(
                     type_id,
                     remote_type_object_))
         {
             std::cout << "Cannot get discovered type from registry:" << std::endl;
-            std::cout << "  - Topic name: " << info.info.topicName() << std::endl;
-            std::cout << "  - Type name:  " << info.info.typeName() << std::endl;
+            std::cout << "  - Topic name: " << info.topic_name << std::endl;
+            std::cout << "  - Type name:  " << info.type_name << std::endl;
         }
 
         // Notify run thread that type has been discovered

diff --git a/examples/cpp/xtypes/SubscriberApp.hpp b/examples/cpp/xtypes/SubscriberApp.hpp
@@ -60,7 +60,8 @@ class SubscriberApp : public Application, public DomainParticipantListener
 
     void on_data_writer_discovery(
             DomainParticipant* participant,
-            eprosima::fastdds::rtps::WriterDiscoveryInfo&& info,
+            eprosima::fastdds::rtps::WriterDiscoveryStatus reason,
+            const eprosima::fastdds::dds::PublicationBuiltinTopicData& info,
             bool& should_be_ignored) override;
 
     //! Run subscriber

diff --git a/include/fastdds/config/doxygen_modules.hpp b/include/fastdds/config/doxygen_modules.hpp
@@ -19,6 +19,8 @@
 #ifndef FASTDDS_CONFIG__DOXYGEN_MODULES_HPP
 #define FASTDDS_CONFIG__DOXYGEN_MODULES_HPP
 
+#include <fastdds/config.hpp>
+
 //Description of doxygen modules, not used in actual code.
 
 /*!
@@ -40,16 +42,35 @@
  * This Module contains the DDS Layer defined by the OMG.
  */
 
+/*!
+ * @defgroup dds_xtypes_typeobject DDS TypeObject API
+ * @ingroup FASTDDS_MODULE
+ */
+
+/*!
+ * @defgroup dynamic_language_binding DDS Dynamic Types API
+ * @ingroup FASTDDS_MODULE
+ */
+
 /** @defgroup FASTDDS_QOS_MODULE Fast DDS Quality of Service (QoS) Module.
  * @ingroup FASTDDS_MODULE
  * @brief QOS class used to define the public entities that the user should use to control this library.
  */
 
+/** @defgroup DEADLINE_MODULE Deadline Module
+ * @ingroup FASTDDS_QOS_MODULE
+ * This module contains the classes associated with the DEADLINE QoS.
+ */
+
 /** @defgroup RTPS_ATTRIBUTES_MODULE RTPS Attributes Module.
  * @ingroup RTPS_MODULE
  * @brief Attributes class used to define the public entities that the user should use to control this library.
  */
 
+/** @defgroup FASTDDS_ATTRIBUTES_MODULE High-level Attributes Module.
+ * @ingroup FASTDDS_MODULE
+ */
+
 /** @defgroup COMMON_MODULE Common Module.
  * @ingroup RTPS_MODULE
  * Common structures used by multiple elements.
@@ -120,6 +141,13 @@
 
 #endif // ifndef DOXYGEN_SHOULD_SKIP_THIS_PUBLIC
 
+#ifdef FASTDDS_STATISTICS
+/** @defgroup STATISTICS_MODULE Statistics Module
+ * @ingroup MANAGEMENT_MODULE
+ * This module contains the classes associated with the Statistics Protocols.
+ */
+#endif // ifdef FASTDDS_STATISTICS
+
 /** @defgroup UTILITIES_MODULE Shared Utilities
  * @ingroup FASTDDS_GENERAL_API
  * Shared utilities that can be used by one or more classes in different modules.

diff --git a/include/fastdds/dds/builtin/topic/BuiltinTopicKey.hpp b/include/fastdds/dds/builtin/topic/BuiltinTopicKey.hpp
@@ -14,32 +14,21 @@
 
 /**
  * @file BuiltinTopicKey.hpp
- *
  */
 
 #ifndef FASTDDS_DDS_BUILTIN_TOPIC__BUILTINTOPICKEY_HPP
 #define FASTDDS_DDS_BUILTIN_TOPIC__BUILTINTOPICKEY_HPP
 
-#include <stdint.h>
+#include <fastdds/rtps/builtin/data/BuiltinTopicKey.hpp>
 
 namespace eprosima {
 namespace fastdds {
 namespace dds {
-namespace builtin {
 
-// following API definition:
-// #define BUILTIN_TOPIC_KEY_TYPE_NATIVE uint32_t
+using BuiltinTopicKey_t = rtps::BuiltinTopicKey_t;
 
-struct BuiltinTopicKey_t
-{
-    // BUILTIN_TOPIC_KEY_TYPE_NATIVE = long type
-    //!Value
-    uint32_t value[3];
-};
-
-} // builtin
-} // dds
-} // fastdds
-} // eprosima
+}  // namespace dds
+}  // namespace fastdds
+}  // namespace eprosima
 
 #endif // FASTDDS_DDS_BUILTIN_TOPIC__BUILTINTOPICKEY_HPP
diff --git a/include/fastdds/dds/builtin/topic/PublicationBuiltinTopicData.hpp b/include/fastdds/dds/builtin/topic/PublicationBuiltinTopicData.hpp
@@ -14,87 +14,21 @@
 
 /**
  * @file PublicationBuiltinTopicData.hpp
- *
  */
 
 #ifndef FASTDDS_DDS_BUILTIN_TOPIC__PUBLICATIONBUILTINTOPICDATA_HPP
 #define FASTDDS_DDS_BUILTIN_TOPIC__PUBLICATIONBUILTINTOPICDATA_HPP
 
-#include <fastdds/dds/builtin/topic/BuiltinTopicKey.hpp>
-#include <fastdds/dds/core/policy/QosPolicies.hpp>
+#include <fastdds/rtps/builtin/data/PublicationBuiltinTopicData.hpp>
 
 namespace eprosima {
 namespace fastdds {
 namespace dds {
-namespace builtin {
 
-struct PublicationBuiltinTopicData
-{
-    //! Builtin topic Key
-    BuiltinTopicKey_t key;
+using PublicationBuiltinTopicData = rtps::PublicationBuiltinTopicData;
 
-    //! Builtin participant topic Key
-    BuiltinTopicKey_t participant_key;
-
-    //! Topic name
-    std::string topic_name;
-
-    //! Type name
-    std::string type_name;
-
-    // DataWriter Qos
-
-    //!Durability Qos, implemented in the library.
-    DurabilityQosPolicy durability;
-
-    //!Durability Service Qos, NOT implemented in the library.
-    DurabilityServiceQosPolicy durability_service;
-
-    //!Deadline Qos, implemented in the library.
-    DeadlineQosPolicy deadline;
-
-    //!Latency Budget Qos, NOT implemented in the library.
-    LatencyBudgetQosPolicy latency_budget;
-
-    //!Liveliness Qos, implemented in the library.
-    LivelinessQosPolicy liveliness;
-
-    //!Reliability Qos, implemented in the library.
-    ReliabilityQosPolicy reliability;
-
-    //!Lifespan Qos, implemented in the library.
-    LifespanQosPolicy lifespan;
-
-    //!User Data Qos, implemented in the library.
-    UserDataQosPolicy user_data;
-
-    //!Ownership Qos, implemented in the library.
-    OwnershipQosPolicy ownership;
-
-    //!Ownership Strength Qos, implemented in the library.
-    OwnershipStrengthQosPolicy ownership_strength;
-
-    //!Destination Order Qos, NOT implemented in the library.
-    DestinationOrderQosPolicy destination_order;
-
-    // Publisher Qos
-
-    //!Presentation Qos, NOT implemented in the library.
-    PresentationQosPolicy presentation;
-
-    //!Partition Qos, implemented in the library.
-    PartitionQosPolicy partition;
-
-    //!Topic Data Qos, NOT implemented in the library.
-    TopicDataQosPolicy topic_data;
-
-    //!Group Data Qos, implemented in the library.
-    GroupDataQosPolicy group_data;
-};
-
-} // builtin
-} // dds
-} // fastdds
-} // eprosima
+}  // namespace dds
+}  // namespace fastdds
+}  // namespace eprosima
 
 #endif // FASTDDS_DDS_BUILTIN_TOPIC__PUBLICATIONBUILTINTOPICDATA_HPP
diff --git a/include/fastdds/dds/domain/DomainParticipantListener.hpp b/include/fastdds/dds/domain/DomainParticipantListener.hpp
@@ -20,12 +20,13 @@
 #ifndef FASTDDS_DDS_DOMAIN__DOMAINPARTICIPANTLISTENER_HPP
 #define FASTDDS_DDS_DOMAIN__DOMAINPARTICIPANTLISTENER_HPP
 
+#include <fastdds/dds/builtin/topic/PublicationBuiltinTopicData.hpp>
 #include <fastdds/dds/publisher/PublisherListener.hpp>
 #include <fastdds/dds/subscriber/SubscriberListener.hpp>
 #include <fastdds/dds/topic/TopicListener.hpp>
 #include <fastdds/rtps/participant/ParticipantDiscoveryInfo.hpp>
 #include <fastdds/rtps/reader/ReaderDiscoveryInfo.hpp>
-#include <fastdds/rtps/writer/WriterDiscoveryInfo.hpp>
+#include <fastdds/rtps/writer/WriterDiscoveryStatus.hpp>
 
 namespace eprosima {
 namespace fastdds {
@@ -116,18 +117,21 @@ class DomainParticipantListener :
      * This method is called when a new DataWriter is discovered, or a previously discovered DataWriter changes
      * its QOS or is removed.
      *
-     * @param [out] participant Pointer to the Participant which discovered the remote DataWriter.
-     * @param [out] info Remote DataWriter information. User can take ownership of the object.
-     * @param [out] should_be_ignored Flag to indicate the library to automatically ignore the discovered DataWriter.
+     * @param [in]  participant        Pointer to the Participant which discovered the remote writer.
+     * @param [in]  reason             The reason motivating this method to be called.
+     * @param [in]  info               Remote writer information.
+     * @param [out] should_be_ignored  Flag to indicate the library to automatically ignore the discovered writer.
      */
     virtual void on_data_writer_discovery(
             DomainParticipant* participant,
-            rtps::WriterDiscoveryInfo&& info,
+            rtps::WriterDiscoveryStatus reason,
+            const PublicationBuiltinTopicData& info,
             bool& should_be_ignored)
     {
         static_cast<void>(participant);
+        static_cast<void>(reason);
         static_cast<void>(info);
-        static_cast<void>(should_be_ignored);
+        should_be_ignored = false;
     }
 
     // TODO: Methods in DomainParticipantListener (p.33 - DDS)

diff --git a/include/fastdds/dds/subscriber/DataReader.hpp b/include/fastdds/dds/subscriber/DataReader.hpp
@@ -977,7 +977,7 @@ class DataReader : public DomainEntity
      * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED
      */
     FASTDDS_EXPORTED_API ReturnCode_t get_matched_publication_data(
-            builtin::PublicationBuiltinTopicData& publication_data,
+            PublicationBuiltinTopicData& publication_data,
             const fastdds::rtps::InstanceHandle_t& publication_handle) const;
 
     /**

diff --git a/include/fastdds/rtps/builtin/data/BuiltinTopicKey.hpp b/include/fastdds/rtps/builtin/data/BuiltinTopicKey.hpp
@@ -0,0 +1,38 @@
+// Copyright 2024 Proyectos y Sistemas de Mantenimiento SL (eProsima).
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/**
+ * @file BuiltinTopicKey.hpp
+ *
+ */
+
+#ifndef FASTDDS_RTPS_BUILTIN_DATA__BUILTINTOPICKEY_HPP
+#define FASTDDS_RTPS_BUILTIN_DATA__BUILTINTOPICKEY_HPP
+
+#include <cstdint>
+
+namespace eprosima {
+namespace fastdds {
+namespace rtps {
+
+struct BuiltinTopicKey_t
+{
+    uint32_t value[3];
+};
+
+} // namespace rtps
+} // namespace fastdds
+} // namespace eprosima
+
+#endif // FASTDDS_RTPS_BUILTIN_DATA__BUILTINTOPICKEY_HPP