DpWriter.hpp

Go to the documentation of this file.

// ======================================================================
// \title  DpWriter.hpp
// \author bocchino
// \brief  hpp file for DpWriter component implementation class
// ======================================================================

#ifndef Svc_DpWriter_HPP
#define Svc_DpWriter_HPP

#include <config/DpCfg.hpp>

#include <atomic>

#include "Fw/Dp/DpContainer.hpp"
#include "Fw/Types/FileNameString.hpp"
#include "Fw/Types/String.hpp"
#include "Fw/Types/SuccessEnumAc.hpp"
#include "Svc/DpWriter/DpWriterComponentAc.hpp"

namespace Svc {

class DpWriter final : public DpWriterComponentBase {
    friend class DpWriterTester;

    // Keep the generated routing arrays consistent with the forwarding contract.
    static_assert(DpWriter::NUM_BUFFERSENDIN_INPUT_PORTS == static_cast<FwSizeType>(DpWriterNumPorts),
                  "Number of buffer send in ports must equal DpWriterNumPorts");
    static_assert(DpWriter::NUM_DPWRITTENOUT_OUTPUT_PORTS == static_cast<FwSizeType>(DpWriterNumPorts),
                  "Number of dp written out ports must equal DpWriterNumPorts");
    static_assert(DpWriter::NUM_DEALLOCBUFFERSENDOUT_OUTPUT_PORTS == static_cast<FwSizeType>(DpWriterNumPorts),
                  "Number of dealloc buffer send out ports must equal DpWriterNumPorts");

  public:
    // ----------------------------------------------------------------------
    // Construction, initialization, and destruction
    // ----------------------------------------------------------------------

    DpWriter(const char* const compName  
    );

    ~DpWriter();

    void configure(const Fw::ConstStringBase& dpFileNamePrefix  
    );

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

    void bufferSendIn_handler(const FwIndexType portNum,  
                              Fw::Buffer& fwBuffer        
                              ) final;

    void schedIn_handler(const FwIndexType portNum,  
                         U32 context                 
                         ) final;

    void schedInInternal_internalInterfaceHandler() final;

    void schedInInternal_overflowHook() final;

  private:
    // ----------------------------------------------------------------------
    // Handler implementations for commands
    // ----------------------------------------------------------------------

    void CLEAR_EVENT_THROTTLE_cmdHandler(FwOpcodeType opCode,  
                                         U32 cmdSeq            
                                         ) final;

  private:
    // ----------------------------------------------------------------------
    // Private helper functions
    // ----------------------------------------------------------------------

    Fw::Success::T deserializePacketHeader(Fw::Buffer& buffer,         
                                           Fw::DpContainer& container  
    );

    void performProcessing(Fw::DpContainer& container  
    );

    Fw::Success::T writeFile(const Fw::DpContainer& container,    
                             const Fw::FileNameString& fileName,  
                             FwSizeType& fileSize                 
    );

    void sendNotification(FwIndexType portNum,                 
                          const Fw::DpContainer& container,    
                          const Fw::FileNameString& fileName,  
                          FwSizeType fileSize                  
    );

  private:
    // ----------------------------------------------------------------------
    // Private member variables
    // ----------------------------------------------------------------------

    U32 m_numBuffersReceived = 0;

    U64 m_numBytesWritten = 0;

    U32 m_numSuccessfulWrites = 0;

    U32 m_numFailedWrites = 0;

    U32 m_numErrors = 0;

    std::atomic<bool> m_schedInQueued{false};

    Fw::FileNameString m_dpFileNamePrefix;
};

}  // end namespace Svc

#endif