All DataWriter::write overload shall return RerturnCode_t type (#…

…5049) * Refs #21329: Update public API Signed-off-by: JesusPoderoso <[email protected]> * Refs #21329: Update Impl Signed-off-by: JesusPoderoso <[email protected]> * Refs #21329: Update usages Signed-off-by: JesusPoderoso <[email protected]> * Refs #21329: Apply Eliana' suggestions Signed-off-by: JesusPoderoso <[email protected]> --------- Signed-off-by: JesusPoderoso <[email protected]>
eProsima · Jul 11, 2024 · a138ed5 · a138ed5
1 parent ace3bc8
commit a138ed5
Show file tree

Hide file tree

Showing 31 changed files with 59 additions and 58 deletions.
diff --git a/examples/cpp/configuration/PublisherApp.cpp b/examples/cpp/configuration/PublisherApp.cpp
@@ -272,7 +272,7 @@ bool PublisherApp::publish()
     if (!is_stopped())
     {
         configuration_.index(configuration_.index() + 1);
-        ret = writer_->write(&configuration_);
+        ret = (RETCODE_OK == writer_->write(&configuration_));
     }
     return ret;
 }

diff --git a/examples/cpp/content_filter/PublisherApp.cpp b/examples/cpp/content_filter/PublisherApp.cpp
@@ -175,7 +175,7 @@ bool PublisherApp::publish()
     if (!is_stopped())
     {
         hello_.index(hello_.index() + 1);
-        ret = writer_->write(&hello_);
+        ret = (RETCODE_OK == writer_->write(&hello_));
     }
     return ret;
 }

diff --git a/examples/cpp/custom_payload_pool/PublisherApp.cpp b/examples/cpp/custom_payload_pool/PublisherApp.cpp
@@ -158,7 +158,7 @@ bool PublisherApp::publish()
     if (!is_stopped())
     {
         hello_.index(hello_.index() + 1);
-        ret = writer_->write(&hello_);
+        ret = (RETCODE_OK == writer_->write(&hello_));
     }
     return ret;
 }

diff --git a/examples/cpp/dds/RequestReplyExample/CalculatorClient.cpp b/examples/cpp/dds/RequestReplyExample/CalculatorClient.cpp
@@ -154,7 +154,8 @@ class CalculatorClient
         request.x(x);
         request.y(y);
 
-        if (request_writer_->write(static_cast<void*>(&request), listener_.write_params))
+        if (eprosima::fastdds::dds::RETCODE_OK ==
+                request_writer_->write(static_cast<void*>(&request), listener_.write_params))
         {
             std::unique_lock<std::mutex> lock(listener_.reception_mutex);
             listener_.reception_cv.wait(lock, [&]()

diff --git a/examples/cpp/delivery_mechanisms/PubSubApp.cpp b/examples/cpp/delivery_mechanisms/PubSubApp.cpp
@@ -394,7 +394,7 @@ bool PubSubApp::publish()
         DeliveryMechanisms* delivery_mechanisms_ = static_cast<DeliveryMechanisms*>(sample_);
         delivery_mechanisms_->index() = ++index_of_last_sample_sent_;
         memcpy(delivery_mechanisms_->message().data(), "Delivery mechanisms", sizeof("Delivery mechanisms"));
-        ret = writer_->write(sample_);
+        ret = (RETCODE_OK == writer_->write(sample_));
         std::cout << "Sample: '" << delivery_mechanisms_->message().data() << "' with index: '"
                   << delivery_mechanisms_->index() << "' SENT" << std::endl;
     }

diff --git a/examples/cpp/delivery_mechanisms/PublisherApp.cpp b/examples/cpp/delivery_mechanisms/PublisherApp.cpp
@@ -289,7 +289,7 @@ bool PublisherApp::publish()
         DeliveryMechanisms* delivery_mechanisms_ = static_cast<DeliveryMechanisms*>(sample_);
         delivery_mechanisms_->index() = ++index_of_last_sample_sent_;
         memcpy(delivery_mechanisms_->message().data(), "Delivery mechanisms", sizeof("Delivery mechanisms"));
-        ret = writer_->write(sample_);
+        ret = (RETCODE_OK == writer_->write(sample_));
         std::cout << "Sample: '" << delivery_mechanisms_->message().data() << "' with index: '"
                   << delivery_mechanisms_->index() << "' SENT" << std::endl;
     }

diff --git a/examples/cpp/discovery_server/ClientPublisherApp.cpp b/examples/cpp/discovery_server/ClientPublisherApp.cpp
@@ -270,7 +270,7 @@ bool ClientPublisherApp::publish()
     if (!is_stopped())
     {
         hello_.index(hello_.index() + 1);
-        ret = writer_->write(&hello_);
+        ret = (RETCODE_OK == writer_->write(&hello_));
     }
     return ret;
 }

diff --git a/examples/cpp/hello_world/PublisherApp.cpp b/examples/cpp/hello_world/PublisherApp.cpp
@@ -156,7 +156,7 @@ bool PublisherApp::publish()
     if (!is_stopped())
     {
         hello_.index(hello_.index() + 1);
-        ret = writer_->write(&hello_);
+        ret = (RETCODE_OK == writer_->write(&hello_));
     }
     return ret;
 }

diff --git a/examples/cpp/xtypes/PublisherApp.cpp b/examples/cpp/xtypes/PublisherApp.cpp
@@ -210,7 +210,7 @@ bool PublisherApp::publish()
         set_uint32_value(hello_, "index", index);
 
         // Publish the sample
-        ret = writer_->write(&hello_);
+        ret = (RETCODE_OK == writer_->write(&hello_));
     }
     return ret;
 }

diff --git a/include/fastdds/dds/publisher/DataWriter.hpp b/include/fastdds/dds/publisher/DataWriter.hpp
@@ -128,19 +128,19 @@ class DataWriter : public DomainEntity
      * Write data to the topic.
      *
      * @param data Pointer to the data
-     * @return True if correct, false otherwise
+     * @return RETCODE_OK if the data is correctly sent or a ReturnCode related to the specific error otherwise.
      */
-    FASTDDS_EXPORTED_API bool write(
+    FASTDDS_EXPORTED_API ReturnCode_t write(
             const void* const data);
 
     /**
      * Write data with params to the topic.
      *
      * @param data Pointer to the data
      * @param params Extra write parameters.
-     * @return True if correct, false otherwise
+     * @return RETCODE_OK if the data is correctly sent or a ReturnCode related to the specific error otherwise.
      */
-    FASTDDS_EXPORTED_API bool write(
+    FASTDDS_EXPORTED_API ReturnCode_t write(
             const void* const data,
             fastdds::rtps::WriteParams& params);
 

diff --git a/src/cpp/fastdds/publisher/DataWriter.cpp b/src/cpp/fastdds/publisher/DataWriter.cpp
@@ -78,13 +78,13 @@ ReturnCode_t DataWriter::discard_loan(
     return impl_->discard_loan(sample);
 }
 
-bool DataWriter::write(
+ReturnCode_t DataWriter::write(
         const void* const data)
 {
     return impl_->write(data);
 }
 
-bool DataWriter::write(
+ReturnCode_t DataWriter::write(
         const void* const data,
         fastdds::rtps::WriteParams& params)
 {

diff --git a/src/cpp/fastdds/publisher/DataWriterImpl.cpp b/src/cpp/fastdds/publisher/DataWriterImpl.cpp
@@ -634,29 +634,29 @@ ReturnCode_t DataWriterImpl::discard_loan(
     return RETCODE_OK;
 }
 
-bool DataWriterImpl::write(
+ReturnCode_t DataWriterImpl::write(
         const void* const data)
 {
     if (writer_ == nullptr)
     {
-        return false;
+        return RETCODE_NOT_ENABLED;
     }
 
     EPROSIMA_LOG_INFO(DATA_WRITER, "Writing new data");
-    return RETCODE_OK == create_new_change(ALIVE, data);
+    return create_new_change(ALIVE, data);
 }
 
-bool DataWriterImpl::write(
+ReturnCode_t DataWriterImpl::write(
         const void* const data,
         fastdds::rtps::WriteParams& params)
 {
     if (writer_ == nullptr)
     {
-        return false;
+        return RETCODE_NOT_ENABLED;
     }
 
     EPROSIMA_LOG_INFO(DATA_WRITER, "Writing new data with WriteParams");
-    return RETCODE_OK == create_new_change_with_params(ALIVE, data, params);
+    return create_new_change_with_params(ALIVE, data, params);
 }
 
 ReturnCode_t DataWriterImpl::check_write_preconditions(

diff --git a/src/cpp/fastdds/publisher/DataWriterImpl.hpp b/src/cpp/fastdds/publisher/DataWriterImpl.hpp
@@ -164,9 +164,9 @@ class DataWriterImpl : protected rtps::IReaderDataFilter
      *
      * @param data Pointer to the data.
      *
-     * @return true if data is correctly delivered to the lower layers, false otherwise.
+     * @return any of the standard return codes.
      */
-    bool write(
+    ReturnCode_t write(
             const void* const data);
 
     /**
@@ -175,9 +175,9 @@ class DataWriterImpl : protected rtps::IReaderDataFilter
      * @param data Pointer to the data.
      * @param params Extra write parameters.
      *
-     * @return true if data is correctly delivered to the lower layers, false otherwise.
+     * @return any of the standard return codes.
      */
-    bool write(
+    ReturnCode_t write(
             const void* const data,
             fastdds::rtps::WriteParams& params);
 

diff --git a/test/blackbox/api/dds-pim/PubSubParticipant.hpp b/test/blackbox/api/dds-pim/PubSubParticipant.hpp
@@ -416,7 +416,7 @@ class PubSubParticipant
             type& msg,
             unsigned int index = 0)
     {
-        return std::get<2>(publishers_[index])->write((void*)&msg);
+        return (eprosima::fastdds::dds::RETCODE_OK == std::get<2>(publishers_[index])->write((void*)&msg));
     }
 
     void assert_liveliness_participant()

diff --git a/test/blackbox/api/dds-pim/PubSubWriter.hpp b/test/blackbox/api/dds-pim/PubSubWriter.hpp
@@ -513,7 +513,7 @@ class PubSubWriter
 
         while (it != msgs.end())
         {
-            if (datawriter_->write((void*)&(*it)))
+            if (eprosima::fastdds::dds::RETCODE_OK == datawriter_->write((void*)&(*it)))
             {
                 default_send_print<type>(*it);
                 it = msgs.erase(it);
@@ -553,7 +553,7 @@ class PubSubWriter
             type& msg)
     {
         default_send_print(msg);
-        return datawriter_->write((void*)&msg);
+        return (eprosima::fastdds::dds::RETCODE_OK == datawriter_->write((void*)&msg));
     }
 
     eprosima::fastdds::dds::ReturnCode_t send_sample(

diff --git a/test/blackbox/api/dds-pim/PubSubWriterReader.hpp b/test/blackbox/api/dds-pim/PubSubWriterReader.hpp
@@ -547,7 +547,7 @@ class PubSubWriterReader
 
         while (it != msgs.end())
         {
-            if (datawriter_->write((void*)&(*it)))
+            if (eprosima::fastdds::dds::RETCODE_OK == datawriter_->write((void*)&(*it)))
             {
                 for (auto& tuple : entities_extra_)
                 {

diff --git a/test/blackbox/api/dds-pim/ReqRepHelloWorldReplier.cpp b/test/blackbox/api/dds-pim/ReqRepHelloWorldReplier.cpp
@@ -158,7 +158,7 @@ void ReqRepHelloWorldReplier::newNumber(
     hello.index(number);
     hello.message("GoodBye");
     wparams.related_sample_identity(sample_identity);
-    ASSERT_EQ(reply_datawriter_->write((void*)&hello, wparams), true);
+    ASSERT_EQ(reply_datawriter_->write((void*)&hello, wparams), eprosima::fastdds::dds::RETCODE_OK);
 }
 
 void ReqRepHelloWorldReplier::wait_discovery()

diff --git a/test/blackbox/api/dds-pim/ReqRepHelloWorldRequester.cpp b/test/blackbox/api/dds-pim/ReqRepHelloWorldRequester.cpp
@@ -239,7 +239,7 @@ void ReqRepHelloWorldRequester::send(
         current_number_ = number;
     }
 
-    ASSERT_EQ(request_datawriter_->write((void*)&hello, wparams), true);
+    ASSERT_EQ(request_datawriter_->write((void*)&hello, wparams), eprosima::fastdds::dds::RETCODE_OK);
     related_sample_identity_ = wparams.sample_identity();
     ASSERT_NE(related_sample_identity_.sequence_number(), eprosima::fastdds::rtps::SequenceNumber_t());
 }
diff --git a/test/blackbox/api/dds-pim/TCPReqRepHelloWorldReplier.cpp b/test/blackbox/api/dds-pim/TCPReqRepHelloWorldReplier.cpp
@@ -194,7 +194,7 @@ void TCPReqRepHelloWorldReplier::newNumber(
     hello.index(number);
     hello.message("GoodBye");
     wparams.related_sample_identity(sample_identity);
-    ASSERT_EQ(reply_datawriter_->write((void*)&hello, wparams), true);
+    ASSERT_EQ(reply_datawriter_->write((void*)&hello, wparams), RETCODE_OK);
 }
 
 void TCPReqRepHelloWorldReplier::wait_discovery(

diff --git a/test/blackbox/api/dds-pim/TCPReqRepHelloWorldRequester.cpp b/test/blackbox/api/dds-pim/TCPReqRepHelloWorldRequester.cpp
@@ -331,7 +331,7 @@ void TCPReqRepHelloWorldRequester::send(
         current_number_ = number;
     }
 
-    ASSERT_EQ(request_datawriter_->write((void*)&hello, wparams), true);
+    ASSERT_EQ(request_datawriter_->write((void*)&hello, wparams), RETCODE_OK);
     related_sample_identity_ = wparams.sample_identity();
     ASSERT_NE(related_sample_identity_.sequence_number(), SequenceNumber_t());
 }
diff --git a/test/blackbox/common/DDSBlackboxTestsBasic.cpp b/test/blackbox/common/DDSBlackboxTestsBasic.cpp
@@ -488,8 +488,8 @@ TEST(DDSBasic, PidRelatedSampleIdentity)
     write_params.related_sample_identity() = related_sample_identity_;
 
     // Publish the new value, deduce the instance handle
-    bool write_ret = native_writer.write((void*)&data, write_params);
-    ASSERT_EQ(true, write_ret);
+    ReturnCode_t write_ret = native_writer.write((void*)&data, write_params);
+    ASSERT_EQ(RETCODE_OK, write_ret);
 
     DataReader& native_reader = reliable_reader.get_native_reader();
 

diff --git a/test/blackbox/common/DDSBlackboxTestsDataReader.cpp b/test/blackbox/common/DDSBlackboxTestsDataReader.cpp
@@ -388,7 +388,7 @@ TEST(DDSDataReader, ConsistentReliabilityWhenIntraprocess)
     auto writer = publisher->create_datawriter( topic, writer_qos );
 
     auto data = HelloWorld{};
-    ASSERT_TRUE(writer->write( &data ));
+    ASSERT_EQ(writer->write( &data ), eprosima::fastdds::dds::RETCODE_OK);
 
     std::this_thread::sleep_for(std::chrono::milliseconds(200));
 

diff --git a/test/blackbox/common/DDSBlackboxTestsMonitorService.cpp b/test/blackbox/common/DDSBlackboxTestsMonitorService.cpp
@@ -253,7 +253,7 @@ class MonitorServiceParticipant
         {
             for (auto& writer : writers_)
             {
-                if (writer->write((void*)&(*it)))
+                if (RETCODE_OK == writer->write((void*)&(*it)))
                 {
                     default_send_print<HelloWorld>(*it);
                     it = msgs.erase(it);
@@ -276,7 +276,7 @@ class MonitorServiceParticipant
     {
         if (!writers_.empty())
         {
-            return writers_.back()->write(&sample);
+            return (RETCODE_OK == writers_.back()->write(&sample));
         }
 
         return false;

diff --git a/test/performance/latency/LatencyTestPublisher.cpp b/test/performance/latency/LatencyTestPublisher.cpp
@@ -766,7 +766,7 @@ bool LatencyTestPublisher::test(
     times_.clear();
     TestCommandType command;
     command.m_command = READY;
-    if (!command_writer_->write(&command))
+    if (RETCODE_OK != command_writer_->write(&command))
     {
         EPROSIMA_LOG_ERROR(LatencyTest, "Publisher cannot publish READY command");
         return false;
@@ -852,7 +852,7 @@ bool LatencyTestPublisher::test(
         start_time_ = std::chrono::steady_clock::now();
 
         // Data publishing
-        if (!data_writer_->write(data))
+        if (RETCODE_OK != data_writer_->write(data))
         {
             // return the loan
             if (data_loans_)

diff --git a/test/performance/latency/LatencyTestSubscriber.cpp b/test/performance/latency/LatencyTestSubscriber.cpp
@@ -548,7 +548,7 @@ void LatencyTestSubscriber::LatencyDataReaderListener::on_data_available(
             std::chrono::duration<uint32_t, std::nano> bounce_time(end_time - start_time);
             reinterpret_cast<LatencyType*>(echoed_loan)->bounce = bounce_time.count();
 
-            if (!sub->data_writer_->write(echoed_loan))
+            if (RETCODE_OK != sub->data_writer_->write(echoed_loan))
             {
                 EPROSIMA_LOG_ERROR(LatencyTest, "Problem echoing Publisher test data with loan");
                 sub->data_writer_->discard_loan(echoed_loan);
@@ -582,7 +582,7 @@ void LatencyTestSubscriber::LatencyDataReaderListener::on_data_available(
                     reinterpret_cast<LatencyType*>(data)->bounce = 0;
                 }
 
-                if (!sub->data_writer_->write(data))
+                if (RETCODE_OK != sub->data_writer_->write(data))
                 {
                     EPROSIMA_LOG_INFO(LatencyTest, "Problem echoing Publisher test data");
                 }
@@ -707,7 +707,7 @@ bool LatencyTestSubscriber::test(
     received_ = 0;
     TestCommandType command;
     command.m_command = BEGIN;
-    if (!command_writer_->write(&command))
+    if (RETCODE_OK != command_writer_->write(&command))
     {
         EPROSIMA_LOG_ERROR(LatencyTest, "Subscriber fail to publish the BEGIN command");
         return false;
@@ -752,7 +752,7 @@ bool LatencyTestSubscriber::test(
     }
 
     command.m_command = END;
-    if (!command_writer_->write(&command))
+    if (RETCODE_OK != command_writer_->write(&command))
     {
         EPROSIMA_LOG_ERROR(LatencyTest, "Subscriber fail to publish the END command");
         return false;

diff --git a/test/performance/throughput/ThroughputPublisher.cpp b/test/performance/throughput/ThroughputPublisher.cpp
@@ -754,7 +754,7 @@ bool ThroughputPublisher::test(
                     // initialize and send the sample
                     static_cast<ThroughputType*>(data)->seqnum = ++seqnum;
 
-                    if (!data_writer_->write(data))
+                    if (RETCODE_OK != data_writer_->write(data))
                     {
                         data_writer_->discard_loan(data);
                     }

diff --git a/test/performance/video/VideoTestPublisher.cpp b/test/performance/video/VideoTestPublisher.cpp
@@ -591,7 +591,7 @@ GstFlowReturn VideoTestPublisher::new_sample(
 
                     if (rand() % 100 > sub->m_dropRate)
                     {
-                        if (!sub->mp_data_dw->write((void*)sub->mp_video_out))
+                        if (RETCODE_OK != sub->mp_data_dw->write((void*)sub->mp_video_out))
                         {
                             std::cout << "VideoPublication::run -> Cannot write video" << std::endl;
                         }

diff --git a/test/profiling/allocations/AllocTestPublisher.cpp b/test/profiling/allocations/AllocTestPublisher.cpp
@@ -220,7 +220,7 @@ bool AllocTestPublisher::publish()
     if (is_matched())
     {
         data_.index(data_.index() + 1);
-        ret = writer_->write(&data_);
+        ret = (RETCODE_OK == writer_->write(&data_));
     }
     return ret;
 }