LogFile.hpp

Go to the documentation of this file.

// \copyright
// Copyright 2009-2015, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
 
#ifndef SVCLOGFILE_HPP_
#define SVCLOGFILE_HPP_
 
#include <Fw/Types/String.hpp>
#include <Os/File.hpp>
#include <Os/FileSystem.hpp>
 
 
namespace Svc {
 
 
    struct LogFile {
 
        LogFile();
 
        ~LogFile();
 
        // ----------------------------------------------------------------------
        // Member Functions
        // ----------------------------------------------------------------------
 
        bool set_log_file(const char* fileName, const U32 maxSize, const U32 maxBackups = 10);
 
        bool write_to_log(const char *const buf, const U32 size);
 
        // ----------------------------------------------------------------------
        // Member Variables
        // ----------------------------------------------------------------------
 
        // The name of the file to text logs to:
        Fw::String m_fileName;
 
        // The file to write text logs to:
        Os::File m_file;
 
        // The max size of the text log file:
        U32 m_maxFileSize;
 
        // True if there is currently an open file to write text logs to:
        bool m_openFile;
 
        // Current size of the file:
        U32 m_currentFileSize;
    };
 
}
#endif /* SVCLOGFILEL_HPP_ */