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/Streamlined/String.h>
#include <OnixS/CME/Streamlined/Integral.h>
#include <OnixS/CME/Streamlined/Logger.h>
#include <OnixS/CME/Streamlined/Time.h>
 
ONIXS_CMESTREAMLINEDMDH_NAMESPACE_BEGIN

ONIXS_CMESTREAMLINEDMDH_LTWT_CLASS FileLoggerSettings
{
    std::string filename_;
    UInt64 fileSizeLimit_;
 
    LogSeverity::Enum severity_;
 
    WatchService* watch_;
 
public:
    FileLoggerSettings()
        : filename_()
        , fileSizeLimit_(2145386496)
        , severity_(LogSeverity::Regular)
        , watch_(&UtcWatch::service())
    {
    }

    ~FileLoggerSettings()
    {
    }

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

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

    UInt64 fileSizeLimit() const
    {
        return fileSizeLimit_;
    }

    void fileSizeLimit(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;
    }
};

ONIXS_CMESTREAMLINEDMDH_EXPORTED
std::string
makeLogFilename(UInt32);
 
ONIXS_CMESTREAMLINEDMDH_EXPORTED_CLASS_DECL(FileLogger);

ONIXS_CMESTREAMLINEDMDH_EXPORTED_STRUCT FileLoggerListener
{
    virtual 
    void 
    onFileLoggerIssue(
        const FileLogger&, 
        const Char*)
    {
    }
};

ONIXS_CMESTREAMLINEDMDH_EXPORTED_CLASS FileLogger : public Logger
{
    // File logger machinery implementation. 
    ONIXS_CMESTREAMLINEDMDH_LTWT_CLASS_DECL(Workhorse);
    Workhorse* workhorse_;
 
public:
    FileLogger(
        const FileLoggerSettings&,
        FileLoggerListener* = ONIXS_CMESTREAMLINEDMDH_NULLPTR);

    ~FileLogger();

    const 
    FileLoggerSettings& 
    settings() const;

    LogEntry* 
    addEntry(
        LogSeverity::Enum);

    std::string rollover();
};
 
ONIXS_CMESTREAMLINEDMDH_NAMESPACE_END