ComLogger.hpp

Go to the documentation of this file.

// ----------------------------------------------------------------------
//
// ComLogger.hpp
//
// ----------------------------------------------------------------------

#ifndef Svc_ComLogger_HPP
#define Svc_ComLogger_HPP

#include <limits.h>
#include <Fw/Types/Assert.hpp>
#include <Fw/Types/FileNameString.hpp>
#include <Os/File.hpp>
#include <Os/Mutex.hpp>
#include <Utils/Hash/Hash.hpp>
#include <cstdarg>
#include <cstdio>
#include "Svc/ComLogger/ComLoggerComponentAc.hpp"

namespace Svc {

class ComLogger final : public ComLoggerComponentBase {
    friend class ComLoggerTester;

    // ----------------------------------------------------------------------
    // Construction, initialization, and destruction
    // ----------------------------------------------------------------------

  public:
    // CONSTRUCTOR:
    // filePrefix: string to prepend the file name with, ie. "thermal_telemetry"
    // maxFileSize: the maximum size a file should reach before being closed and a new one opened
    // storeBufferLength: if true, store the length of each com buffer before storing the buffer itself,
    //                    otherwise just store the com buffer. false might be advantageous in a system
    //                    where you can ensure that all buffers given to the ComLogger are the same size
    //                    in which case you do not need the overhead. Or you store an id which you can
    //                    match to an expected size on the ground during post processing.
    ComLogger(const char* compName, const char* filePrefix, U32 maxFileSize, bool storeBufferLength = true);

    // CONSTRUCTOR:
    ComLogger(const char* compName);

    // filePrefix: string to prepend the file name with, ie. "thermal_telemetry"
    // maxFileSize: the maximum size a file should reach before being closed and a new one opened
    // storeBufferLength: if true, store the length of each com buffer before storing the buffer itself,
    //                    otherwise just store the com buffer. false might be advantageous in a system
    //                    where you can ensure that all buffers given to the ComLogger are the same size
    //                    in which case you do not need the overhead. Or you store an id which you can
    //                    match to an expected size on the ground during post processing.
    void init_log_file(const char* filePrefix, U32 maxFileSize, bool storeBufferLength = true);

    ~ComLogger();

    // ----------------------------------------------------------------------
    // Handler implementations
    // ----------------------------------------------------------------------

  private:
    void comIn_handler(FwIndexType portNum, Fw::ComBuffer& data, U32 context);

    void CloseFile_cmdHandler(FwOpcodeType opCode, U32 cmdSeq);

    void pingIn_handler(const FwIndexType portNum, 
                        U32 key                    
    );

    // The filename data:
    Fw::FileNameString m_filePrefix;
    U32 m_maxFileSize;

    // ----------------------------------------------------------------------
    // Internal state:
    // ----------------------------------------------------------------------
    enum FileMode { CLOSED = 0, OPEN = 1 };

    FileMode m_fileMode;
    Os::File m_file;

    Fw::FileNameString m_fileName;
    Fw::FileNameString m_hashFileName;
    U32 m_byteCount;
    bool m_writeErrorOccurred;
    bool m_openErrorOccurred;
    bool m_storeBufferLength;
    bool m_initialized;

    // ----------------------------------------------------------------------
    // File functions:
    // ----------------------------------------------------------------------
    void openFile();

    void closeFile();

    void writeComBufferToFile(Fw::ComBuffer& data, U16 size);

    // ----------------------------------------------------------------------
    // Helper functions:
    // ----------------------------------------------------------------------

    bool writeToFile(void* data, U16 length);

    void writeHashFile();
};
}  // namespace Svc

#endif