Add new Svc::ComRetry component

Add new component that can be used by other components to resend
a message on failure.

Author: valdaarhun

Svc/ComRetry/ComRetry.cpp

@@ -0,0 +1,67 @@
+// ======================================================================
+// \title  ComRetry.cpp
+// \author valdaarhun
+// \brief  cpp file for ComRetry component implementation class
+// ======================================================================
+
+#include "Svc/ComRetry/ComRetry.hpp"
+#include "ComRetry.hpp"
+
+namespace Svc {
+
+// ----------------------------------------------------------------------
+// Component construction and destruction
+// ----------------------------------------------------------------------
+
+ComRetry ::ComRetry(const char* const compName)
+    : ComRetryComponentBase(compName),
+      m_num_retries(1),
+      m_retry_count(0),
+      m_bufferState(OWNED) {}
+
+ComRetry ::~ComRetry() {}
+
+void ComRetry::configure(U32 num_retries) {
+    this->m_num_retries = num_retries;
+}
+
+// ----------------------------------------------------------------------
+// Handler implementations for typed input ports
+// ----------------------------------------------------------------------
+
+void ComRetry ::comStatusIn_handler(FwIndexType portNum, Fw::Success& condition) {
+    // TODO: Check if m_buffer is valid before attempting delivery
+    if (condition == Fw::Success::SUCCESS) {
+        this->dataReturnOut_out(0, this->m_buffer, this->m_context);
+        this->comStatusOut_out(0, condition);
+    }
+    // Delivery of last message failed
+    else if (this->m_retry_count < this->m_num_retries) {
+        FW_ASSERT(this->m_bufferState == Fw::Buffer::OwnershipState::OWNED);
+        this->m_bufferState = Fw::Buffer::OwnershipState::NOT_OWNED;
+        this->m_retry_count++;
+        this->dataOut_out(0, this->m_buffer, this->m_context);
+    }
+    // All retries failed, send FAILURE to upstream component
+    else {
+        this->dataReturnOut_out(0, this->m_buffer, this->m_context);
+        this->m_retry_count = 0;
+        Fw::Success condition = Fw::Success::FAILURE;
+        this->comStatusOut_out(0, condition);
+    }
+}
+
+void ComRetry ::dataIn_handler(FwIndexType portNum, Fw::Buffer& buffer, const ComCfg::FrameContext& context) {
+    FW_ASSERT(this->m_bufferState == Fw::Buffer::OwnershipState::OWNED);
+    this->m_bufferState = Fw::Buffer::OwnershipState::NOT_OWNED;
+    this->dataOut_out(0, buffer, context);
+}
+
+void ComRetry ::dataReturnIn_handler(FwIndexType portNum, Fw::Buffer& buffer, const ComCfg::FrameContext& context) {
+    FW_ASSERT(this->m_bufferState == Fw::Buffer::OwnershipState::NOT_OWNED);
+    this->m_bufferState = Fw::Buffer::OwnershipState::OWNED;
+    this->m_buffer = buffer;
+    this->m_context = context;
+}
+
+}  // namespace Svc

Svc/ComRetry/ComRetry.fpp

@@ -0,0 +1,14 @@
+module Svc {
+    @ A component for retrying message delivery on failure
+    active component ComRetry {
+        import Svc.Framer
+
+        # One async command/port is required for active components
+        # This should be overridden by the developers with a useful command/port
+        @ TODO
+        async input port TODO: Svc.Sched
+
+        # @ Example parameter
+        # param PARAMETER_NAME: U32
+    }
+}

Svc/ComRetry/ComRetry.hpp

@@ -0,0 +1,70 @@
+// ======================================================================
+// \title  ComRetry.hpp
+// \author valdaarhun
+// \brief  hpp file for ComRetry component implementation class
+// ======================================================================
+
+#ifndef Svc_ComRetry_HPP
+#define Svc_ComRetry_HPP
+
+#include "Svc/ComRetry/ComRetryComponentAc.hpp"
+
+namespace Svc {
+
+class ComRetry final : public ComRetryComponentBase {
+  public:
+    // ----------------------------------------------------------------------
+    // Component construction and destruction
+    // ----------------------------------------------------------------------
+
+    //! Construct ComRetry object
+    ComRetry(const char* const compName  //!< The component name
+    );
+
+    //! Destroy ComRetry object
+    ~ComRetry();
+
+    //! Configure the number of retries
+    void configure(U32 num_retries  //!< Number of retries allowed
+    );
+
+  private:
+    // ----------------------------------------------------------------------
+    // Handler implementations for typed input ports
+    // ----------------------------------------------------------------------
+
+    //! Handler implementation for comStatusIn
+    //!
+    //! Resend last delivered message on failure
+    void comStatusIn_handler(FwIndexType portNum,    //!< The port number
+                             Fw::Success& condition  //!< Condition success/failure
+                             ) override;
+
+    //! Handler implementation for dataIn
+    //!
+    //! Port to receive data to frame, in a Fw::Buffer with optional context
+    void dataIn_handler(FwIndexType portNum,  //!< The port number
+                        Fw::Buffer& data,
+                        const ComCfg::FrameContext& context) override;
+
+    //! Handler implementation for dataReturnIn
+    //!
+    //! Buffer coming from a deallocate call in a ComDriver component
+    void dataReturnIn_handler(FwIndexType portNum,  //!< The port number
+                              Fw::Buffer& data,
+                              const ComCfg::FrameContext& context) override;
+
+  private:
+    // ----------------------------------------------------------------------
+    // Member variables
+    // ----------------------------------------------------------------------
+    U32 m_num_retries;                                  //!< Maximum number of retries
+    U32 m_retry_count;                                  //!< Track number of attempted retries
+    ComCfg::FrameContext m_context;                     //!< Context for the current frame
+    Fw::Buffer m_buffer;                                //!< Store incoming buffer
+    Fw::Buffer::OwnershipState m_bufferState;           //!< Track ownership of stored buffer
+};
+
+}  // namespace Svc
+
+#endif