YiLogPolicy.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2017. All rights reserved.
#ifndef _YI_LOG_POLICY_H_
#define _YI_LOG_POLICY_H_

#include "logging/YiLoggerCommon.h"
#include "thread/YiThread.h"
#include "utility/YiConcurrentQueue.h"
#include "utility/YiPreferences.h"

class CYILoggingThread;
class CYILogger;
class CYILoggerCrashHandler;
class CYILogLinesCache;

const uint32_t YI_LOG_MESSAGE_MAX_SIZE = 8192;

class CYILogPolicy
{
    friend class CYILogger;
    friend class CYILoggerPriv;
    friend class CYILoggingThread;
    friend class CYILoggerCrashHandler;

public:
    CYILogPolicy();

    virtual ~CYILogPolicy();

    virtual void Open() = 0;

    virtual void Close() = 0;

    virtual bool IsOpen() const = 0;

    void PostWrite(YI_LOGGING_PARAMS &loggingParams);

    void SetPreferences(const std::shared_ptr<CYIPreferences> &pPrefs);

    const std::shared_ptr<CYIPreferences> &GetPreferences() const;

    void UpdateConfigMonitor() const;

    void SetWriteDirectEnabled(bool bEnabled);

    bool IsWriteDirectEnabled() const;
    
    void SetUseLinesCache(bool bUseLinesCache);
    
    std::vector<CYIString> GetLastLoggedLines(uint32_t uLinesCount = std::numeric_limits<uint32_t>::max()) const;

protected:

    void EnableTimeStamp();
    void EnableClassName();
    void EnableLineNumber();
    void EnableSeverity();
    void EnableTagName();

    void DisableTimeStamp();
    void DisableClassName();
    void DisableLineNumber();
    void DisableSeverity();
    void DisableTagName();

    virtual CYIString BuildLogStatement(const CYIString &logStatement, const YI_LOGGING_PARAMS &params);
    
    CYIConcurrentQueue<YI_LOGGING_PARAMS> m_logQueue;

    uint32_t m_uAttributeCache;

private:
    virtual void FlushLogQueue();

    CYILogPolicy(const CYILogPolicy &policy)
    {
        YI_UNUSED(policy);
    }

    CYILogPolicy &operator=(const CYILogPolicy &policy)
    {
        YI_UNUSED(policy);
        return *this;
    }

    CYIString ParsePropertyName(  const CYIString &propName,
                                  const CYIString &prefix);

    YI_LOG_SEVERITY ParseSeverityType(const CYIString &propTagName);

    std::map<CYIString, YI_LOG_SEVERITY> BuildSeverityTagCache(
        const CYIPreferences &prefs);

    virtual void _Write(const YI_LOGGING_PARAMS &loggingParams)
    {
        YI_UNUSED(loggingParams);
    }

    virtual void _WriteDirect(const YI_LOGGING_PARAMS &loggingParams)
    {
        YI_UNUSED(loggingParams);
    }

    std::shared_ptr<CYIPreferences> m_pPreferences;

    std::map<CYIString, YI_LOG_SEVERITY> m_severityTagCache;

    bool m_bDirectWriteEnabled;

    YI_LOG_SEVERITY m_eDefaultSeverity;

    char *m_pCachedVarArgMessage;

    CYIMutex m_workerMutex;

    CYIMutex m_cacheMsgMutex;

    mutable CYIMutex m_prefsMutex;

    CYILoggingThread *m_pLoggingWorker;
    
    CYILogLinesCache *m_pLinesCache;

    bool m_bDestroyingLogPolicy;
};

#endif // _YI_LOG_POLICY_H_