introduced ITransferIdMap and ITransferIdStorage interfaces

Author: serges147

include/libcyphal/presentation/client_impl.hpp

@@ -13,7 +13,7 @@
 #include "libcyphal/executor.hpp"
 #include "libcyphal/transport/errors.hpp"
 #include "libcyphal/transport/svc_sessions.hpp"
-#include "libcyphal/transport/transfer_id_generators.hpp"
+#include "libcyphal/transport/transfer_id_map.hpp"
 #include "libcyphal/transport/types.hpp"
 #include "libcyphal/types.hpp"
 
@@ -34,7 +34,9 @@ namespace presentation
 namespace detail
 {
 
-class SharedClient : public common::cavl::Node<SharedClient>, public SharedObject
+class SharedClient : public common::cavl::Node<SharedClient>,
+                     public SharedObject,
+                     public transport::detail::ITransferIdStorage
 {
 public:
     using Node::remove;
@@ -135,6 +137,7 @@ class SharedClient : public common::cavl::Node<SharedClient>, public SharedObjec
         , svc_response_rx_session_{std::move(svc_response_rx_session)}
         , response_rx_params_{svc_response_rx_session_->getParams()}
         , nearest_deadline_{DistantFuture()}
+        , transfer_id_{0}
     {
         CETL_DEBUG_ASSERT(svc_request_tx_session_ != nullptr, "");
         CETL_DEBUG_ASSERT(svc_response_rx_session_ != nullptr, "");
@@ -144,7 +147,7 @@ class SharedClient : public common::cavl::Node<SharedClient>, public SharedObjec
         // Otherwise, the responses would be rejected (as "duplicates") if their transfer IDs are in order.
         // Real duplicates (f.e. caused by redundant transports) won't cause any issues
         // b/c shared RPC client expects/accepts only one response per transfer ID,
-        // and corresponding promise callback node will be removed after the first response.
+        // and the corresponding promise callback node will be removed after the first response.
         svc_response_rx_session_->setTransferIdTimeout({});
 
         svc_response_rx_session_->setOnReceiveCallback([this](const auto& arg) {
@@ -243,6 +246,18 @@ class SharedClient : public common::cavl::Node<SharedClient>, public SharedObjec
         delegate_.forgetSharedClient(*this);
     }
 
+    // MARK: ITransferIdStorage
+
+    transport::TransferId load() const noexcept override
+    {
+        return transfer_id_;
+    }
+
+    void save(const transport::TransferId transfer_id) noexcept override
+    {
+        transfer_id_ = transfer_id;
+    }
+
 protected:
     virtual void insertNewCallbackNode(CallbackNode& callback_node)
     {
@@ -392,15 +407,16 @@ class SharedClient : public common::cavl::Node<SharedClient>, public SharedObjec
     TimePoint                                      nearest_deadline_;
     common::cavl::Tree<TimeoutNode>                timeout_nodes_by_deadline_;
     IExecutor::Callback::Any                       nearest_deadline_callback_;
+    transport::TransferId                          transfer_id_;
 
 };  // SharedClient
 
 // MARK: -
 
 /// @brief Defines a shared client implementation that uses a generic transfer ID generator.
 ///
-template <typename TransferIdGeneratorMixin>
-class ClientImpl final : public SharedClient, private TransferIdGeneratorMixin
+template <typename TransferIdGenerator>
+class ClientImpl final : public SharedClient
 {
 public:
     ClientImpl(IPresentationDelegate&                   delegate,
@@ -409,7 +425,7 @@ class ClientImpl final : public SharedClient, private TransferIdGeneratorMixin
                UniquePtr<transport::IResponseRxSession> svc_response_rx_session,
                const transport::TransferId              transfer_id_modulo)
         : SharedClient{delegate, executor, std::move(svc_request_tx_session), std::move(svc_response_rx_session)}
-        , TransferIdGeneratorMixin{transfer_id_modulo}
+        , transfer_id_generator_{transfer_id_modulo, *this}
     {
     }
 
@@ -424,40 +440,41 @@ class ClientImpl final : public SharedClient, private TransferIdGeneratorMixin
 private:
     using Base = SharedClient;
 
-    // MARK: SharedClient
-
-    CETL_NODISCARD cetl::optional<transport::TransferId> nextTransferId() noexcept override
-    {
-        return TransferIdGeneratorMixin::nextTransferId();
-    }
-
     void insertNewCallbackNode(CallbackNode& callback_node) override
     {
         SharedClient::insertNewCallbackNode(callback_node);
-        TransferIdGeneratorMixin::retainTransferId(callback_node.getTransferId());
+        transfer_id_generator_.retainTransferId(callback_node.getTransferId());
     }
 
     void removeCallbackNode(CallbackNode& callback_node) override
     {
-        TransferIdGeneratorMixin::releaseTransferId(callback_node.getTransferId());
+        transfer_id_generator_.releaseTransferId(callback_node.getTransferId());
         SharedClient::removeCallbackNode(callback_node);
     }
 
+    // MARK: SharedClient
+
+    CETL_NODISCARD cetl::optional<transport::TransferId> nextTransferId() noexcept override
+    {
+        return transfer_id_generator_.nextTransferId();
+    }
+
+    TransferIdGenerator transfer_id_generator_;
+
 };  // ClientImpl<TransferIdGeneratorMixin>
 
 /// @brief Defines a shared client specialization that uses a trivial transfer ID generator.
 ///
 template <>
-class ClientImpl<transport::detail::TrivialTransferIdGenerator> final
-    : public SharedClient,
-      private transport::detail::TrivialTransferIdGenerator
+class ClientImpl<transport::detail::TrivialTransferIdGenerator> final : public SharedClient
 {
 public:
     ClientImpl(IPresentationDelegate&                   delegate,
                IExecutor&                               executor,
                UniquePtr<transport::IRequestTxSession>  svc_request_tx_session,
                UniquePtr<transport::IResponseRxSession> svc_response_rx_session)
         : Base{delegate, executor, std::move(svc_request_tx_session), std::move(svc_response_rx_session)}
+        , transfer_id_generator_{*this}
     {
     }
 
@@ -476,9 +493,11 @@ class ClientImpl<transport::detail::TrivialTransferIdGenerator> final
 
     CETL_NODISCARD cetl::optional<transport::TransferId> nextTransferId() noexcept override
     {
-        return TrivialTransferIdGenerator::nextTransferId();
+        return transfer_id_generator_.nextTransferId();
     }
 
+    transport::detail::TrivialTransferIdGenerator transfer_id_generator_;
+
 };  // ClientImpl<TrivialTransferIdGenerator>
 
 }  // namespace detail

include/libcyphal/presentation/presentation.hpp

@@ -23,7 +23,7 @@
 #include "libcyphal/transport/errors.hpp"
 #include "libcyphal/transport/msg_sessions.hpp"
 #include "libcyphal/transport/svc_sessions.hpp"
-#include "libcyphal/transport/transfer_id_generators.hpp"
+#include "libcyphal/transport/transfer_id_map.hpp"
 #include "libcyphal/transport/transport.hpp"
 #include "libcyphal/transport/types.hpp"
 #include "libcyphal/types.hpp"

include/libcyphal/presentation/publisher_impl.hpp

@@ -12,6 +12,7 @@
 #include "libcyphal/common/cavl/cavl.hpp"
 #include "libcyphal/transport/errors.hpp"
 #include "libcyphal/transport/msg_sessions.hpp"
+#include "libcyphal/transport/transfer_id_map.hpp"
 #include "libcyphal/transport/types.hpp"
 #include "libcyphal/types.hpp"