Logger.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  Logger.qm Copyright 2018 - 2024 Qore Technologies, s.r.o.
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
*/
 
// minimum required Qore version
 
 
 
// import native code for logger
 
 
namespace Logger {
 
class LoggerEventParameter {
 
public:
private:
        code callable;
        *list<auto> args;
 
public:
 
 
    constructor(code func, ...);
 
 
 
     auto call();
};
 
 
class LoggerAppenderQueueThreadPool : public LoggerAppenderQueue {
 
public:
private:
        ThreadPool threadPool;
        Counter runningCounter(0);
        int maxThreads;
        hash<auto> pendingEvents;
        hash<auto> processingEvents;
        Queue finishedEvents();
        Sequence lastId(0);
        Mutex lock();
 
public:
 
 
private:
     worker(string id, LoggerAppender appender, list<auto> events);
public:
 
 
 
    constructor(ThreadPool tp, int max_threads = -1);
 
 
    destructor();
 
 
     ThreadPool getThreadPool();
 
 
     process(timeout ms = 0);
 
     int size();
};
 
 
class LoggerAppenderNull : public LoggerAppender {
 
public:
    constructor(*string name);
 
 
protected:
     auto serializeImpl(LoggerEvent event);
public:
 
 
     processEventImpl(int type, auto params);
};
 
 
class LoggerAppenderStream : public LoggerAppenderWithLayout {
 
public:
private:
        StreamWriter writer;
        bool closed = False;
        bool assignThread;
 
public:
 
 
    constructor(*string name, LoggerLayout layout, StreamWriter writer);
 
 
     StreamWriter getStreamWriter();
 
     bool hasAssignThread();
 
     processEventImpl(int type, auto params);
};
 
 
class LoggerAppenderStdOut : public LoggerAppenderWithLayout {
 
public:
 
    constructor(*string name, LoggerLayout layout);
 
 
 
     processEventImpl(int type, auto params);
};
 
 
class LoggerAppenderStdErr : public LoggerAppenderWithLayout {
 
public:
 
    constructor(*string name, LoggerLayout layout);
 
 
 
     processEventImpl(int type, auto params);
};
 
class AbstractLoggerAppenderFileRotate : public LoggerAppenderFile  {
 
public:
        const EVENT_ROTATE = 10001;
        const EVENT_REOPEN = 10002;
        const DEFAULT_ROTATION_COUNT = 10;
 
    constructor(*string name, LoggerLayout layout, *string encoding) : LoggerAppenderFile(name, layout, '', encoding) {} 
 
 
 
     reopen();
 
     abstract int getCount();};
 
 
class LoggerAppenderFileRotate : public AbstractLoggerAppenderFileRotate,  protected LoggerPattern  {
 
public:
        const DEFAULT_ARCHIVE_PATTERN = "%p%f.%i";
 
private:
        int count;
 
public:
 
 
    constructor(*string name, LoggerLayout layout, string filename, int count = DEFAULT_ROTATION_COUNT, string archive = DEFAULT_ARCHIVE_PATTERN, *string encoding)
 ;
 
 
 
protected:
     *string resolveField(auto data, string key, *string option);
public:
 
 
 
     processEventImpl(int type, auto params);
 
 
     string getArchiveFileName(int idx);
 
     int getCount();
};
 
 
class LoggerAppenderFileRing : public AbstractLoggerAppenderFileRotate,  protected LoggerPattern  {
 
public:
        const DEFAULT_DATE_FORMAT = "YYYYMMDDHHmmSS";
 
private:
        hash<auto> patternData;
 
public:
 
 
    constructor(*string name, LoggerLayout layout, string pattern, int count = DEFAULT_ROTATION_COUNT, *string encoding);
 
 
 
protected:
     *string resolveField(auto data, string key, *string option);
public:
 
 
 
     processEventImpl(int type, auto params);
 
     int getCount();
 
     int getCurrentIndex();
};
 
 
class LoggerAppenderFileArchive : public LoggerAppenderFile,  protected LoggerPattern  {
 
public:
        const EVENT_ARCHIVE = 20;
        const DEFAULT_DATE_FORMAT = "YYYYMMDDHHmmSS";
        const DEFAULT_ARCHIVE_PATTERN = "%p%f.%d";
 
 
    constructor(*string name, LoggerLayout layout, string filename, string archive = DEFAULT_ARCHIVE_PATTERN, *string encoding);
 
 
 
protected:
     *string resolveField(auto data, string key, *string option);
public:
 
 
 
     processEventImpl(int type, auto params);
 
 
     string archive();
 
 
     string getArchiveFileName();
};
 
 
class LoggerFilterLevel : public LoggerFilter {
 
public:
private:
        Qore::Logger::LoggerLevel minLevel;
        Qore::Logger::LoggerLevel maxLevel;
 
public:
 
 
    constructor(Qore::Logger::LoggerLevel min_value = Qore::Logger::LoggerLevel::LevelInfo, Qore::Logger::LoggerLevel max_value = Qore::Logger::LoggerLevel::LevelOff);
 
 
 
    constructor(int min_value, int max_value = Qore::Logger::LoggerLevel::OFF);
 
 
 
    constructor(string min_value, string max_value = 'OFF');
 
 
 
     setMinLevel(LoggerLevel value);
 
 
     setMinLevel(int value);
 
 
     setMinLevel(string value);
 
     LoggerLevel getMinLevel();
 
 
     setMaxLevel(LoggerLevel value);
 
 
     setMaxLevel(int value);
 
 
     setMaxLevel(string value);
 
     Qore::Logger::LoggerLevel getMaxLevel();
 
     int eval(LoggerEvent event);
};
 
 
class LoggerFilterRegex : public LoggerFilter {
 
public:
private:
        string regexStr;
        bool regexResult;
 
public:
 
 
    constructor(string regex_str = '', bool regex_result = True);
 
 
 
     setRegex(string regex_str, bool regex_result = True);
 
     string getRegex();
 
     bool getRegexResult();
 
     int eval(LoggerEvent event);
};
 
class LoggerWrapper : public LoggerInterface {
 
public:
protected:
        transient *LoggerInterface logger;
 
public:
 
    constructor();
 
 
    constructor(LoggerInterface logger);
 
 
    bool isLogger(LoggerInterface logger);
 
 
    setLogger(*LoggerInterface logger);
 
 
 
    log(Qore::Logger::LoggerLevel level, string message, ...);
 
 
 
    log(int level, string message, ...);
 
 
 
    log(string level, string message, ...);
 
 
 
    logArgs(Qore::Logger::LoggerLevel level, string message, *softlist<auto> args);
 
 
 
    logArgs(int level, string message, *softlist<auto> args);
 
 
 
    logArgs(string level, string message, *softlist<auto> args);
 
 
 
    logEvent(LoggerEvent event);
 
 
 
    trace(string message, ...);
 
 
 
    debug(string message, ...);
 
 
 
    info(string message, ...);
 
 
 
    warn(string message, ...);
 
 
 
    error(string message, ...);
 
 
 
    fatal(string message, ...);
 
 
 
    assertLog(bool assertion, string message, ...);
 
 
 
    traceVar(string var_name, auto value);
 
 
 
    debugVar(string var_name, auto value);
 
 
 
    bool isEnabledFor(LoggerLevel level);
 
 
 
    bool isEnabledFor(int level);
 
 
 
    bool isEnabledFor(string level);
 
 
    bool isTraceEnabled();
 
 
    bool isDebugEnabled();
 
 
    bool isInfoEnabled();
 
 
    bool isWarnEnabled();
 
 
    bool isErrorEnabled();
 
 
    bool isFatalEnabled();
 
 
 
    setLevel(*LoggerLevel level);
 
 
 
    setLevel(string level);
 
 
 
    setLevel(int level);
 
 
 
    *LoggerLevel decLevel();
 
 
 
    *LoggerLevel incLevel();
 
 
 
    *LoggerLevel getLevel(bool effective = True);
 
 
protected:
     *LoggerInterface getLogger();
public:
 
};
 
class LoggerRoot : public Logger {
 
public:
    // Creates the object
    constructor(LoggerLevel level = LoggerLevel::getLevelAll());
 
 
    // Creates the object
    constructor(int level);
 
 
    // Creates the object
    constructor(string level);
 
 
 
     setLevel(*LoggerLevel value);
 
 
     setParent(*Logger value);
};
 
 
class StdoutAppender : public LoggerAppenderWithLayout {
 
public:
    constructor() ;
 
 
    processEventImpl(int type, auto params);
 
};
};