[21137] RTPS WriterHistory refactor

examples/cpp/rtps/AsSocket/TestWriterSocket.cpp

@@ -89,10 +89,7 @@ void TestWriterSocket::run(
 {
     for (int i = 0; i < nmsgs; ++i )
     {
-        CacheChange_t* ch = mp_writer->new_change([]() -> uint32_t
-                        {
-                            return 255;
-                        }, ALIVE);
+        CacheChange_t* ch = mp_history->create_change(255, ALIVE);
 #if defined(_WIN32)
         ch->serializedPayload.length =
                 sprintf_s((char*)ch->serializedPayload.data, 255, "My example string %d", i) + 1;

examples/cpp/rtps/Persistent/TestWriterPersistent.cpp

@@ -112,18 +112,12 @@ void TestWriterPersistent::run(
 
     for (int i = 0; i < samples; ++i )
     {
-        CacheChange_t* ch = mp_writer->new_change([]() -> uint32_t
-                        {
-                            return 255;
-                        }, ALIVE);
+        CacheChange_t* ch = mp_history->create_change(255, ALIVE);
         if (!ch)     // In the case history is full, remove some old changes
         {
             std::cout << "cleaning history...";
-            mp_writer->remove_older_changes(20);
-            ch = mp_writer->new_change([]() -> uint32_t
-                            {
-                                return 255;
-                            }, ALIVE);
+            mp_history->remove_min_change();
+            ch = mp_history->create_change(255, ALIVE);
         }
 
 #if defined(_WIN32)

examples/cpp/rtps/Registered/TestWriterRegistered.cpp

@@ -103,18 +103,12 @@ void TestWriterRegistered::run(
 
     for (int i = 0; i < samples; ++i )
     {
-        CacheChange_t* ch = mp_writer->new_change([]() -> uint32_t
-                        {
-                            return 255;
-                        }, ALIVE);
+        CacheChange_t* ch = mp_history->create_change(255, ALIVE);
         if (!ch)     // In the case history is full, remove some old changes
         {
             std::cout << "cleaning history...";
-            mp_writer->remove_older_changes(20);
-            ch = mp_writer->new_change([]() -> uint32_t
-                            {
-                                return 255;
-                            }, ALIVE);
+            mp_history->remove_min_change();
+            ch = mp_history->create_change(255, ALIVE);
         }
 
 #if defined(_WIN32)

include/fastdds/rtps/Endpoint.hpp

@@ -62,11 +62,6 @@ class Endpoint
 
     virtual ~Endpoint()
     {
-        // As releasing the change pool will delete the cache changes it owns,
-        // the payload pool may be called to release their payloads, so we should
-        // ensure that the payload pool is destroyed after the change pool.
-        change_pool_.reset();
-        payload_pool_.reset();
     }
 
 public:
@@ -120,12 +115,6 @@ class Endpoint
     //!Endpoint Mutex
     mutable RecursiveTimedMutex mp_mutex;
 
-    //!Pool of serialized payloads.
-    std::shared_ptr<IPayloadPool> payload_pool_;
-
-    //!Pool of cache changes.
-    std::shared_ptr<IChangePool> change_pool_;
-
     //!Fixed size of payloads
     uint32_t fixed_payload_size_ = 0;
 

include/fastdds/rtps/RTPSDomain.hpp

@@ -113,92 +113,32 @@ class RTPSDomain
 
     /**
      * Create a RTPSWriter in a participant.
-     * @param p Pointer to the RTPSParticipant.
-     * @param watt Writer Attributes.
-     * @param hist Pointer to the WriterHistory.
-     * @param listen Pointer to the WriterListener.
-     * @return Pointer to the created RTPSWriter.
      *
-     * \warning The returned pointer is invalidated after a call to removeRTPSWriter() or stopAll(),
-     *          so its use may result in undefined behaviour.
-     */
-    FASTDDS_EXPORTED_API static RTPSWriter* createRTPSWriter(
-            RTPSParticipant* p,
-            WriterAttributes& watt,
-            WriterHistory* hist,
-            WriterListener* listen = nullptr);
-
-    /**
-     * Create a RTPSWriter in a participant using a custom payload pool.
-     * @param p Pointer to the RTPSParticipant.
-     * @param watt Writer Attributes.
-     * @param payload_pool Shared pointer to the IPayloadPool
-     * @param hist Pointer to the WriterHistory.
-     * @param listen Pointer to the WriterListener.
-     * @return Pointer to the created RTPSWriter.
-     *
-     * \warning The returned pointer is invalidated after a call to removeRTPSWriter() or stopAll(),
-     *          so its use may result in undefined behaviour.
-     */
-    FASTDDS_EXPORTED_API static RTPSWriter* createRTPSWriter(
-            RTPSParticipant* p,
-            WriterAttributes& watt,
-            const std::shared_ptr<IPayloadPool>& payload_pool,
-            WriterHistory* hist,
-            WriterListener* listen = nullptr);
-
-    /**
-     * Create a RTPSWriter in a participant using a custom payload pool.
-     * @param p Pointer to the RTPSParticipant.
-     * @param watt Writer Attributes.
-     * @param payload_pool Shared pointer to the IPayloadPool
-     * @param change_pool Shared pointer to the IChangePool
-     * @param hist Pointer to the WriterHistory.
-     * @param listen Pointer to the WriterListener.
-     * @return Pointer to the created RTPSWriter.
+     * @param p       Pointer to the RTPSParticipant.
+     * @param watt    Writer Attributes.
+     * @param hist    Pointer to the WriterHistory.
+     * @param listen  Pointer to the WriterListener.
      *
-     * \warning The returned pointer is invalidated after a call to removeRTPSWriter() or stopAll(),
-     *          so its use may result in undefined behaviour.
-     */
-    FASTDDS_EXPORTED_API static RTPSWriter* createRTPSWriter(
-            RTPSParticipant* p,
-            WriterAttributes& watt,
-            const std::shared_ptr<IPayloadPool>& payload_pool,
-            const std::shared_ptr<IChangePool>& change_pool,
-            WriterHistory* hist,
-            WriterListener* listen = nullptr);
-
-    /**
-     * Create a RTPSWriter in a participant using a custom payload pool.
-     * @param p Pointer to the RTPSParticipant.
-     * @param entity_id Specific entity id to use for the created writer.
-     * @param watt Writer Attributes.
-     * @param payload_pool Shared pointer to the IPayloadPool
-     * @param change_pool Shared pointer to the IChangePool
-     * @param hist Pointer to the WriterHistory.
-     * @param listen Pointer to the WriterListener.
      * @return Pointer to the created RTPSWriter.
      *
      * \warning The returned pointer is invalidated after a call to removeRTPSWriter() or stopAll(),
      *          so its use may result in undefined behaviour.
      */
     FASTDDS_EXPORTED_API static RTPSWriter* createRTPSWriter(
             RTPSParticipant* p,
-            const EntityId_t& entity_id,
             WriterAttributes& watt,
-            const std::shared_ptr<IPayloadPool>& payload_pool,
-            const std::shared_ptr<IChangePool>& change_pool,
             WriterHistory* hist,
             WriterListener* listen = nullptr);
 
     /**
      * Create a RTPSWriter in a participant.
-     * @param p Pointer to the RTPSParticipant.
-     * @param entity_id Specific entity id to use for the created writer.
-     * @param watt Writer Attributes.
-     * @param payload_pool Shared pointer to the IPayloadPool
-     * @param hist Pointer to the WriterHistory.
-     * @param listen Pointer to the WriterListener.
+     *
+     * @param p          Pointer to the RTPSParticipant.
+     * @param entity_id  Specific entity id to use for the created writer.
+     * @param watt       Writer Attributes.
+     * @param hist       Pointer to the WriterHistory.
+     * @param listen     Pointer to the WriterListener.
+     *
      * @return Pointer to the created RTPSWriter.
      *
      * \warning The returned pointer is invalidated after a call to removeRTPSWriter() or stopAll(),
@@ -208,7 +148,6 @@ class RTPSDomain
             RTPSParticipant* p,
             const EntityId_t& entity_id,
             WriterAttributes& watt,
-            const std::shared_ptr<IPayloadPool>& payload_pool,
             WriterHistory* hist,
             WriterListener* listen = nullptr);
 

include/fastdds/rtps/history/History.hpp

@@ -271,10 +271,6 @@ class History
     //!Print the seqNum of the changes in the History (for debuggisi, mng purposes).
     void print_changes_seqNum2();
 
-    FASTDDS_EXPORTED_API virtual bool do_reserve_cache(
-            CacheChange_t** change,
-            uint32_t size) = 0;
-
     FASTDDS_EXPORTED_API virtual void do_release_cache(
             CacheChange_t* ch) = 0;
 

include/fastdds/rtps/history/ReaderHistory.hpp

@@ -233,10 +233,6 @@ class ReaderHistory : public History
 
 protected:
 
-    FASTDDS_EXPORTED_API bool do_reserve_cache(
-            CacheChange_t** change,
-            uint32_t size) override;
-
     FASTDDS_EXPORTED_API void do_release_cache(
             CacheChange_t* ch) override;
 

include/fastdds/rtps/history/WriterHistory.hpp

@@ -20,13 +20,23 @@
 #ifndef FASTDDS_RTPS_HISTORY__WRITERHISTORY_HPP
 #define FASTDDS_RTPS_HISTORY__WRITERHISTORY_HPP
 
-#include <fastdds/rtps/history/History.hpp>
+#include <cstdint>
+#include <memory>
+
+#include <fastdds/fastdds_dll.hpp>
 #include <fastdds/dds/log/Log.hpp>
+#include <fastdds/rtps/common/CacheChange.hpp>
+#include <fastdds/rtps/common/ChangeKind_t.hpp>
+#include <fastdds/rtps/common/InstanceHandle.hpp>
+#include <fastdds/rtps/history/History.hpp>
+#include <fastdds/rtps/history/IChangePool.hpp>
+#include <fastdds/rtps/history/IPayloadPool.hpp>
 
 namespace eprosima {
 namespace fastdds {
 namespace rtps {
 
+class HistoryAttributes;
 class RTPSWriter;
 class WriteParams;
 
@@ -48,12 +58,81 @@ class WriterHistory : public rtps::History
 public:
 
     /**
-     * Constructor of the WriterHistory.
+     * @brief Construct a WriterHistory.
+     *
+     * @param att  Attributes configuring the WriterHistory.
+     */
+    FASTDDS_EXPORTED_API WriterHistory(
+            const HistoryAttributes& att);
+
+    /**
+     * @brief Construct a WriterHistory with a custom payload pool.
+     *
+     * @param att           Attributes configuring the WriterHistory.
+     * @param payload_pool  Pool of payloads to be used by the WriterHistory.
+     */
+    FASTDDS_EXPORTED_API WriterHistory(
+            const HistoryAttributes& att,
+            const std::shared_ptr<IPayloadPool>& payload_pool);
+
+    /**
+     * @brief Construct a WriterHistory with custom payload and change pools.
+     *
+     * @param att           Attributes configuring the WriterHistory.
+     * @param payload_pool  Pool of payloads to be used by the WriterHistory.
+     * @param change_pool   Pool of changes to be used by the WriterHistory.
      */
     FASTDDS_EXPORTED_API WriterHistory(
-            const HistoryAttributes&  att);
+            const HistoryAttributes& att,
+            const std::shared_ptr<IPayloadPool>& payload_pool,
+            const std::shared_ptr<IChangePool>& change_pool);
+
     FASTDDS_EXPORTED_API virtual ~WriterHistory() override;
 
+    /**
+     * @brief Get the payload pool used by this history.
+     *
+     * @return Reference to the payload pool used by this history.
+     */
+    FASTDDS_EXPORTED_API const std::shared_ptr<IPayloadPool>& get_payload_pool() const;
+
+    /**
+     * @brief Get the change pool used by this history.
+     *
+     * @return Reference to the change pool used by this history.
+     */
+    FASTDDS_EXPORTED_API const std::shared_ptr<IChangePool>& get_change_pool() const;
+
+    /**
+     * @brief Create a new CacheChange_t object.
+     *
+     * @param change_kind  Kind of the change.
+     * @param handle       InstanceHandle_t of the change.
+     *
+     * @return Pointer to the new CacheChange_t object.
+     *
+     * @pre A writer has been associated with this history
+     */
+    FASTDDS_EXPORTED_API CacheChange_t* create_change(
+            ChangeKind_t change_kind,
+            InstanceHandle_t handle = c_InstanceHandle_Unknown);
+
+    /**
+     * @brief Create a new CacheChange_t object with a specific payload size.
+     *
+     * @param payload_size  Size of the payload.
+     * @param change_kind   Kind of the change.
+     * @param handle        InstanceHandle_t of the change.
+     *
+     * @return Pointer to the new CacheChange_t object.
+     *
+     * @pre A writer has been associated with this history
+     */
+    FASTDDS_EXPORTED_API CacheChange_t* create_change(
+            uint32_t payload_size,
+            ChangeKind_t change_kind,
+            InstanceHandle_t handle = c_InstanceHandle_Unknown);
+
     /**
      * Add a CacheChange_t to the WriterHistory.
      * @param a_change Pointer to the CacheChange_t to be added.
@@ -141,11 +220,24 @@ class WriterHistory : public rtps::History
         return m_lastCacheChangeSeqNum + 1;
     }
 
-protected:
+    /**
+     * Release a change when it is not being used anymore.
+     *
+     * @param ch Pointer to the cache change to be released.
+     *
+     * @returns whether the operation succeeded or not
+     *
+     * @pre
+     *     @li A writer has been associated with this history
+     *     @li @c ch is not @c nullptr
+     *     @li @c ch points to a cache change obtained from a call to @c this->create_change
+     *
+     * @post memory pointed to by @c ch is not accessed
+     */
+    FASTDDS_EXPORTED_API bool release_change(
+            CacheChange_t* ch);
 
-    FASTDDS_EXPORTED_API bool do_reserve_cache(
-            CacheChange_t** change,
-            uint32_t size) override;
+protected:
 
     FASTDDS_EXPORTED_API void do_release_cache(
             CacheChange_t* ch) override;
@@ -211,9 +303,9 @@ class WriterHistory : public rtps::History
     }
 
     //!Last CacheChange Sequence Number added to the History.
-    SequenceNumber_t m_lastCacheChangeSeqNum;
+    SequenceNumber_t m_lastCacheChangeSeqNum {};
     //!Pointer to the associated RTPSWriter;
-    RTPSWriter* mp_writer;
+    RTPSWriter* mp_writer = nullptr;
 
     uint32_t high_mark_for_frag_ = 0;
 
@@ -248,6 +340,11 @@ class WriterHistory : public rtps::History
 
     void set_fragments(
             CacheChange_t* change);
+
+    /// Reference to the change pool used by this history.
+    std::shared_ptr<IChangePool> change_pool_;
+    /// Reference to the payload pool used by this history.
+    std::shared_ptr<IPayloadPool> payload_pool_;
 };
 
 } // namespace rtps