FprimeRouter.hpp

Go to the documentation of this file.

// ======================================================================
// \title  FprimeRouter.hpp
// \author thomas-bc
// \brief  hpp file for FprimeRouter component implementation class
// ======================================================================

#ifndef Svc_FprimeRouter_HPP
#define Svc_FprimeRouter_HPP

#include "Fw/Types/ActiveEnumAc.hpp"
#include "Fw/Types/SuccessEnumAc.hpp"
#include "Svc/FprimeRouter/FprimeRouterComponentAc.hpp"
#include "config/FppConstantsAc.hpp"

namespace Svc {

class FprimeRouter final : public FprimeRouterComponentBase {
  public:
    // ----------------------------------------------------------------------
    // Component construction and destruction
    // ----------------------------------------------------------------------

    FprimeRouter(const char* const compName  
    );

    ~FprimeRouter();

  private:
    // ----------------------------------------------------------------------
    // Handler implementations for user-defined typed input ports
    // ----------------------------------------------------------------------

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

    // ! Handler for input port cmdResponseIn
    // ! This is a no-op because FprimeRouter does not need to handle command responses
    // ! but the port must be connected
    void cmdResponseIn_handler(FwIndexType portNum,             
                               FwOpcodeType opcode,             
                               U32 cmdSeq,                      
                               const Fw::CmdResponse& response  
                               ) override;

    void fileBufferReturnIn_handler(FwIndexType portNum,  
                                    Fw::Buffer& fwBuffer  
                                    ) override;

  private:
    // ----------------------------------------------------------------------
    // Buffer-to-context association table
    // ----------------------------------------------------------------------

    struct BufferContextEntry {
        Fw::Active state;              
        const U8* key;                 
        ComCfg::FrameContext context;  
    };

    Fw::Success insertContext(const Fw::Buffer& buffer, const ComCfg::FrameContext& context);

    Fw::Success takeContext(const Fw::Buffer& buffer, ComCfg::FrameContext& context);

    BufferContextEntry m_bufferContextTable[FprimeRouterCfg::BufferContextTableSize];
};
}  // namespace Svc

#endif