CommandDispatcherImpl.hpp

Go to the documentation of this file.

#ifndef COMMANDDISPATCHERIMPL_HPP_
#define COMMANDDISPATCHERIMPL_HPP_

#include <atomic>

#include <Fw/DataStructures/ArrayMap.hpp>
#include <Fw/DataStructures/RedBlackTreeMap.hpp>
#include <Os/Mutex.hpp>
#include <Svc/CmdDispatcher/CommandDispatcherComponentAc.hpp>
#include <config/CommandDispatcherImplCfg.hpp>

namespace Svc {


class CommandDispatcherImpl final : public CommandDispatcherComponentBase {
    friend class CommandDispatcherTester;

  public:
    CommandDispatcherImpl(const char* name);
    virtual ~CommandDispatcherImpl();

    void configure(bool executeWhenSequenceTableFull = CmdDispatcherCfg::EXECUTE_WHEN_SEQUENCE_TABLE_FULL_DEFAULT);

  protected:
  private:
    void compCmdStat_handler(FwIndexType portNum,
                             FwOpcodeType opCode,
                             U32 cmdSeq,
                             const Fw::CmdResponse& response) override;
    void seqCmdBuff_handler(FwIndexType portNum, Fw::ComBuffer& data, U32 context) override;
    void compCmdReg_handler(FwIndexType portNum, FwOpcodeType opCode) override;
    void pingIn_handler(FwIndexType portNum, U32 key) override;

    void run_handler(FwIndexType portNum,  
                     U32 context           
                     ) override;

    void CMD_NO_OP_cmdHandler(FwOpcodeType opCode, U32 cmdSeq) override;
    void CMD_NO_OP_STRING_cmdHandler(FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg& arg1) override;
    void CMD_TEST_CMD_1_cmdHandler(FwOpcodeType opCode, U32 cmdSeq, I32 arg1, F32 arg2, U8 arg3) override;
    void CMD_CLEAR_TRACKING_cmdHandler(FwOpcodeType opCode, U32 cmdSeq) override;

    void seqCmdBuff_overflowHook(FwIndexType portNum, Fw::ComBuffer& data, U32 context) override;

    void advanceSequenceNumber();

    U32 allocateSequenceNumber();

    Fw::RedBlackTreeMap<FwOpcodeType, FwIndexType, CMD_DISPATCHER_DISPATCH_TABLE_SIZE> m_entryTable;


    struct SequenceTrackerEntry {
        FwOpcodeType opCode;     
        U32 context;             
        FwIndexType callerPort;  
    };

    Fw::ArrayMap<U32, SequenceTrackerEntry, CMD_DISPATCHER_SEQUENCER_TABLE_SIZE> m_sequenceTracker;

    U32 m_seq;          
    bool m_seqWrapped;  

    bool m_executeWhenSequenceTableFull;  

    U32 m_numCmdsDispatched;  
    U32 m_numCmdErrors;       
    std::atomic<U32>
        m_numCmdsDropped;  
};
}  // namespace Svc

#endif /* COMMANDDISPATCHERIMPL_HPP_ */