file_appender.h

Go to the documentation of this file.

 
#ifndef CPPLOGGING_APPENDERS_FILE_APPENDER_H
#define CPPLOGGING_APPENDERS_FILE_APPENDER_H
 
#include "logging/appender.h"
 
#include "filesystem/filesystem.h"
 
#include <atomic>
 
namespace CppLogging {
 
 
class FileAppender : public Appender
{
public:
 
    explicit FileAppender(const CppCommon::Path& file, bool truncate = false, bool auto_flush = false, bool auto_start = true);
    FileAppender(const FileAppender&) = delete;
    FileAppender(FileAppender&&) = delete;
    virtual ~FileAppender();
 
    FileAppender& operator=(const FileAppender&) = delete;
    FileAppender& operator=(FileAppender&&) = delete;
 
    // Implementation of Appender
    bool IsStarted() const noexcept override { return _started; }
    bool Start() override;
    bool Stop() override;
    void AppendRecord(Record& record) override;
    void Flush() override;
 
private:
    std::atomic<bool> _started{false};
    CppCommon::Timestamp _retry{0};
    CppCommon::File _file;
    bool _truncate;
    bool _auto_flush;
 
    /*
        - If the file is opened and ready to write immediately returns true
        - If the last retry was earlier than 100ms immediately returns false
        - If the file is closed try to open it for writing, returns true/false
 
        \return 'true' if the file was successfully prepared, 'false' if the file failed to be prepared
    */
    bool PrepareFile();
    /*
        \return 'true' if the file was successfully closed, 'false' if the file failed to close
    */
    bool CloseFile();
};
 
} // namespace CppLogging
 
#endif // CPPLOGGING_APPENDERS_FILE_APPENDER_H