Add documentation for has_more_replies (#1091)

* Refs #23365. Regenerate code.

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>

* Refs #23365. Add API aliases.

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>

* Refs #23365. Add paragraphs regarding new field.

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>

* Refs #23365. Update example code.

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>

---------

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>

Author: MiguelCompany

code/DDSCodeTester.cpp

@@ -8045,6 +8045,10 @@ void rpcdds_internal_api_examples()
         if (expected_request_info.related_sample_identity == received_request_info.related_sample_identity)
         {
           // Received Reply sample is associated to the sent Request sample
+          if (received_request_info.has_more_replies)
+          {
+              // More replies for the same request will be received
+          }
         }
 
         // Delete created Requester
@@ -8125,15 +8129,26 @@ void rpcdds_internal_api_examples()
 
         // ... Process received data
 
-        // Send a Reply with the received related_sample_identity
+        // Send a Reply with the received related_sample_identity, indicating there will be more replies.
         void* reply_data = reply_type_support->create_data();
+        received_request_info.has_more_replies = true;
         ret = replier->send_reply(reply_data, received_request_info);
         if (RETCODE_OK != ret)
         {
             // Error
             return;
         }
 
+        // Send a Reply with the received related_sample_identity, indicating it is the last one.
+        void* reply_data_2 = reply_type_support->create_data();
+        received_request_info.has_more_replies = false;
+        ret = replier->send_reply(reply_data_2, received_request_info);
+        if (RETCODE_OK != ret)
+        {
+            // Error
+            return;
+        }
+
         /* Delete created Replier */
         ret = participant->delete_service_replier(replier->get_service_name(), replier);
         if (RETCODE_OK != ret)

code/Examples/C++/DDSHelloWorld/src/HelloWorldTypeObjectSupport.cxx

@@ -32,7 +32,6 @@
 #include <fastdds/dds/xtypes/type_representation/ITypeObjectRegistry.hpp>
 #include <fastdds/dds/xtypes/type_representation/TypeObject.hpp>
 #include <fastdds/dds/xtypes/type_representation/TypeObjectUtils.hpp>
-
 #include "HelloWorld.hpp"
 
 
@@ -135,4 +134,3 @@ void register_HelloWorld_type_identifier(
         }
     }
 }
-

code/Examples/C++/DDSHelloWorld/src/HelloWorldTypeObjectSupport.hpp

@@ -43,15 +43,14 @@
  *        Hash TypeIdentifiers require to fill the TypeObject information and hash it, consequently, the TypeObject is
  *        indirectly registered as well.
  *
- * @param[out] TypeIdentifier of the registered type.
+ * @param[out] type_ids TypeIdentifier of the registered type.
  *             The returned TypeIdentifier corresponds to the complete TypeIdentifier in case of hashed TypeIdentifiers.
  *             Invalid TypeIdentifier is returned in case of error.
  */
 eProsima_user_DllExport void register_HelloWorld_type_identifier(
         eprosima::fastdds::dds::xtypes::TypeIdentifierPair& type_ids);
 
 
-
 #endif // DOXYGEN_SHOULD_SKIP_THIS_PUBLIC
 
 #endif // FAST_DDS_GENERATED__HELLOWORLD_TYPE_OBJECT_SUPPORT_HPP

code/Examples/C++/RpcClientServerBasic/src/types/calculatorPubSubTypes.cxx

@@ -175,6 +175,11 @@ namespace calculator_example {
             delete pData;
         }
 
+        eProsima_user_DllExport void register_type_object_representation() override
+        {
+            register_Calculator_Request_type_identifier(type_identifiers_);
+        }
+
     };
 
     class Calculator_ReplyPubSubType : public eprosima::fastdds::dds::TopicDataType
@@ -318,6 +323,11 @@ namespace calculator_example {
             delete pData;
         }
 
+        eProsima_user_DllExport void register_type_object_representation() override
+        {
+            register_Calculator_Reply_type_identifier(type_identifiers_);
+        }
+
     };
 
     eprosima::fastdds::dds::rpc::ServiceTypeSupport create_Calculator_service_type_support()

code/Examples/C++/RpcClientServerBasic/src/types/calculatorTypeObjectSupport.cxx

@@ -38,6 +38,33 @@
 #ifndef DOXYGEN_SHOULD_SKIP_THIS_PUBLIC
 
 namespace calculator_example {
+/**
+ * @brief Register Calculator_Request related TypeIdentifier.
+ *        Fully-descriptive TypeIdentifiers are directly registered.
+ *        Hash TypeIdentifiers require to fill the TypeObject information and hash it, consequently, the TypeObject is
+ *        indirectly registered as well.
+ *
+ * @param[out] type_ids TypeIdentifier of the registered type.
+ *             The returned TypeIdentifier corresponds to the complete TypeIdentifier in case of hashed TypeIdentifiers.
+ *             Invalid TypeIdentifier is returned in case of error.
+ */
+eProsima_user_DllExport void register_Calculator_Request_type_identifier(
+        eprosima::fastdds::dds::xtypes::TypeIdentifierPair& type_ids);
+
+/**
+ * @brief Register Calculator_Reply related TypeIdentifier.
+ *        Fully-descriptive TypeIdentifiers are directly registered.
+ *        Hash TypeIdentifiers require to fill the TypeObject information and hash it, consequently, the TypeObject is
+ *        indirectly registered as well.
+ *
+ * @param[out] type_ids TypeIdentifier of the registered type.
+ *             The returned TypeIdentifier corresponds to the complete TypeIdentifier in case of hashed TypeIdentifiers.
+ *             Invalid TypeIdentifier is returned in case of error.
+ */
+eProsima_user_DllExport void register_Calculator_Reply_type_identifier(
+        eprosima::fastdds::dds::xtypes::TypeIdentifierPair& type_ids);
+
+
 } // namespace calculator_example
 
 

code/Examples/C++/RpcClientServerBasic/src/types/calculatorTypeObjectSupport.hpp

@@ -175,6 +175,11 @@ namespace calculator_example {
             delete pData;
         }
 
+        eProsima_user_DllExport void register_type_object_representation() override
+        {
+            register_Calculator_Request_type_identifier(type_identifiers_);
+        }
+
     };
 
     class Calculator_ReplyPubSubType : public eprosima::fastdds::dds::TopicDataType
@@ -318,6 +323,11 @@ namespace calculator_example {
             delete pData;
         }
 
+        eProsima_user_DllExport void register_type_object_representation() override
+        {
+            register_Calculator_Reply_type_identifier(type_identifiers_);
+        }
+
     };
 
     eprosima::fastdds::dds::rpc::ServiceTypeSupport create_Calculator_service_type_support()

code/Examples/C++/RpcClientServerFeed/src/types/calculatorPubSubTypes.cxx

@@ -253,6 +253,7 @@ class CalculatorServerLogic
             : info_(info)
             , replier_(replier)
         {
+            info_.has_more_replies = true;
             reply_.fibonacci_seq = calculator_example::detail::Calculator_fibonacci_seq_Result{};
             reply_.fibonacci_seq->result = calculator_example::detail::Calculator_fibonacci_seq_Out{};
         }
@@ -541,6 +542,7 @@ class CalculatorServerLogic
             : info_(info)
             , replier_(replier)
         {
+            info_.has_more_replies = true;
             reply_.accumulator = calculator_example::detail::Calculator_accumulator_Result{};
             reply_.accumulator->result = calculator_example::detail::Calculator_accumulator_Out{};
         }
@@ -710,6 +712,7 @@ class CalculatorServerLogic
             : info_(info)
             , replier_(replier)
         {
+            info_.has_more_replies = true;
             reply_.filter = calculator_example::detail::Calculator_filter_Result{};
             reply_.filter->result = calculator_example::detail::Calculator_filter_Out{};
         }