ComStub.hpp

Go to the documentation of this file.

// ======================================================================
// \title  ComStub.hpp
// \author mstarch
// \brief  hpp file for ComStub component implementation class
// ======================================================================

#ifndef Svc_ComStub_HPP
#define Svc_ComStub_HPP

#include "Drv/ByteStreamDriverModel/ByteStreamStatusEnumAc.hpp"
#include "Svc/ComStub/ComStubComponentAc.hpp"

namespace Svc {

class ComStub final : public ComStubComponentBase {
    friend class ComStubTester;  

  public:
    const FwIndexType RETRY_LIMIT = 10;
    // ----------------------------------------------------------------------
    // Construction, initialization, and destruction
    // ----------------------------------------------------------------------

    ComStub(const char* const compName 
    );

    ~ComStub() override;

    // ----------------------------------------------------------------------
    // Handler implementations for user-defined typed input ports
    // ----------------------------------------------------------------------
  private:
    void dataIn_handler(const FwIndexType portNum, 
                        Fw::Buffer& sendBuffer,
                        const ComCfg::FrameContext& context) override;

    void drvConnected_handler(const FwIndexType portNum) override;

    void drvReceiveIn_handler(const FwIndexType portNum, Fw::Buffer& recvBuffer,
                              const Drv::ByteStreamStatus& recvStatus) override;

    void dataReturnIn_handler(FwIndexType portNum,   
                              Fw::Buffer& fwBuffer,  
                              const ComCfg::FrameContext& context) override;

    void drvAsyncSendReturnIn_handler(FwIndexType portNum,   
                                      Fw::Buffer& fwBuffer,  
                                      const Drv::ByteStreamStatus& recvStatus) override;

    // ----------------------------------------------------------------------
    // Helper methods
    // ----------------------------------------------------------------------
  private:
    void handleSynchronousSend(Fw::Buffer& sendBuffer, const ComCfg::FrameContext& context);

    void handleAsynchronousSend(Fw::Buffer& sendBuffer, const ComCfg::FrameContext& context);

    void handleAsyncRetry(Fw::Buffer& fwBuffer);

    // ----------------------------------------------------------------------
    // Member variables
    // ----------------------------------------------------------------------
  private:
    bool m_reinitialize;                   
    ComCfg::FrameContext m_storedContext;  
    FwIndexType m_retry_count;             
};

}  // end namespace Svc

#endif