FileLogger.h

Go to the documentation of this file.

// Copyright Onix Solutions Limited [OnixS]. All rights reserved.
//
// This software owned by Onix Solutions Limited [OnixS] and is
// protected by copyright law and international copyright treaties.
//
// Access to and use of the software is governed by the terms of the applicable
// OnixS Software Services Agreement (the Agreement) and Customer end user license
// agreements granting a non-assignable, non-transferable and non-exclusive license
// to use the software for it's own data processing purposes under the terms defined
// in the Agreement.
//
// Except as otherwise granted within the terms of the Agreement, copying or
// reproduction of any part of this source code or associated reference material
// to any other location for further reproduction or redistribution, and any
// amendments to this copyright notice, are expressly prohibited.
//
// Any reproduction or redistribution for sale or hiring of the Software not in
// accordance with the terms of the Agreement is a violation of copyright law.
//
 
#pragma once
 
#include <OnixS/CME/MDH/messaging/String.h>
#include <OnixS/CME/MDH/messaging/Integral.h>
 
#include <OnixS/CME/MDH/Logger.h>
#include <OnixS/CME/MDH/Watch.h>
 
#include <OnixS/CME/MDH/Auxiliary/DeprecatedHeaderWarnings.Disable.h>
#include <OnixS/CME/MDH/String.h>
#include <OnixS/CME/MDH/Auxiliary/DeprecatedHeaderWarnings.Restore.h>
 
ONIXS_CMEMDH_NAMESPACE_BEGIN

class ONIXS_CMEMDH_LTWT FileLoggerSettings
{
public:
    FileLoggerSettings()
        : filename_()
        , fileSizeLimit_(2145386496)
        , severity_(LogSeverity::Regular)
        , watch_(&UtcWatch::service())
    {
    }

    ~FileLoggerSettings() = default;

    const std::string& filename() const
    {
        return filename_;
    }

    void filename(const std::string& value)
    {
        filename_ = value;
    }

    Messaging::UInt64 fileSizeLimit() const
    {
        return fileSizeLimit_;
    }

    void fileSizeLimit(Messaging::UInt64 value)
    {
        fileSizeLimit_ = value;
    }

    LogSeverity::Enum severityLevel() const
    {
        return severity_;
    }

    void severityLevel(LogSeverity::Enum value)
    {
        severity_ = value;
    }

    WatchService& watch() const
    {
        return *watch_;
    }

    void watch(WatchService& watch)
    {
        watch_ = &watch;
    }
 
private:
    std::string filename_;
    Messaging::UInt64 fileSizeLimit_;
 
    LogSeverity::Enum severity_;
 
    WatchService* watch_;
};

ONIXS_CMEMDH_EXPORTED
std::string makeLogFilename(Messaging::UInt32);
 
ONIXS_CMEMDH_EXPORTED_CLASS_DECL(FileLogger);

struct ONIXS_CMEMDH_EXPORTED FileLoggerListener
{
    virtual void onFileLoggerIssue(const FileLogger&, const Messaging::Char*) {}
};

class ONIXS_CMEMDH_EXPORTED FileLogger : public Logger
{
public:
    FileLogger(const FileLoggerSettings&, FileLoggerListener* = nullptr);

    ~FileLogger() override;

    const FileLoggerSettings& settings() const;

    void info(std::string&) override;

    LogEntry* addEntry(LogSeverity::Enum) override;

    std::string rollover();
 
private:
    // File logger machinery implementation.
    ONIXS_CMEMDH_LTWT_CLASS_DECL(Workhorse);
 
    Workhorse* workhorse_;
};
 
ONIXS_CMEMDH_NAMESPACE_END