class Poco::Logger

Overview

Logger is a special Channel that acts as the main entry point into the logging framework. More…

#include <Logger.h>

class Logger: public Poco::Channel
{
public:
    // fields

    static const std::string ROOT;

    // methods

    const std::string&
    name() const;

    void
    setChannel(Channel* pChannel);

    Channel*
    getChannel() const;

    void
    setLevel(int level);

    int
    getLevel() const;

    void
    setLevel(const std::string& level);

    virtual
    void
    setProperty(
        const std::string& name,
        const std::string& value
        );

    virtual
    void
    log(const Message& msg);

    void
    log(const Exception& exc);

    void
    log(
        const Exception& exc,
        const char* file,
        int line
        );

    void
    fatal(const std::string& msg);

    void
    fatal(
        const std::string& msg,
        const char* file,
        int line
        );

    void
    fatal(
        const std::string& fmt,
        const Any& value1
        );

    void
    fatal(
        const std::string& fmt,
        const Any& value1,
        const Any& value2
        );

    void
    fatal(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3
        );

    void
    fatal(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4
        );

    void
    fatal(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5
        );

    void
    fatal(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6
        );

    void
    fatal(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6,
        const Any& value7
        );

    void
    fatal(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6,
        const Any& value7,
        const Any& value8
        );

    void
    fatal(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6,
        const Any& value7,
        const Any& value8,
        const Any& value9
        );

    void
    fatal(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6,
        const Any& value7,
        const Any& value8,
        const Any& value9,
        const Any& value10
        );

    void
    critical(const std::string& msg);

    void
    critical(
        const std::string& msg,
        const char* file,
        int line
        );

    void
    critical(
        const std::string& fmt,
        const Any& value1
        );

    void
    critical(
        const std::string& fmt,
        const Any& value1,
        const Any& value2
        );

    void
    critical(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3
        );

    void
    critical(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4
        );

    void
    critical(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5
        );

    void
    critical(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6
        );

    void
    critical(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6,
        const Any& value7
        );

    void
    critical(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6,
        const Any& value7,
        const Any& value8
        );

    void
    critical(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6,
        const Any& value7,
        const Any& value8,
        const Any& value9
        );

    void
    critical(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6,
        const Any& value7,
        const Any& value8,
        const Any& value9,
        const Any& value10
        );

    void
    error(const std::string& msg);

    void
    error(
        const std::string& msg,
        const char* file,
        int line
        );

    void
    error(
        const std::string& fmt,
        const Any& value1
        );

    void
    error(
        const std::string& fmt,
        const Any& value1,
        const Any& value2
        );

    void
    error(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3
        );

    void
    error(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4
        );

    void
    error(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5
        );

    void
    error(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6
        );

    void
    error(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6,
        const Any& value7
        );

    void
    error(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6,
        const Any& value7,
        const Any& value8
        );

    void
    error(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6,
        const Any& value7,
        const Any& value8,
        const Any& value9
        );

    void
    error(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6,
        const Any& value7,
        const Any& value8,
        const Any& value9,
        const Any& value10
        );

    void
    warning(const std::string& msg);

    void
    warning(
        const std::string& msg,
        const char* file,
        int line
        );

    void
    warning(
        const std::string& fmt,
        const Any& value1
        );

    void
    warning(
        const std::string& fmt,
        const Any& value1,
        const Any& value2
        );

    void
    warning(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3
        );

    void
    warning(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4
        );

    void
    warning(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5
        );

    void
    warning(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6
        );

    void
    warning(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6,
        const Any& value7
        );

    void
    warning(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6,
        const Any& value7,
        const Any& value8
        );

    void
    warning(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6,
        const Any& value7,
        const Any& value8,
        const Any& value9
        );

    void
    warning(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6,
        const Any& value7,
        const Any& value8,
        const Any& value9,
        const Any& value10
        );

    void
    notice(const std::string& msg);

    void
    notice(
        const std::string& msg,
        const char* file,
        int line
        );

    void
    notice(
        const std::string& fmt,
        const Any& value1
        );

    void
    notice(
        const std::string& fmt,
        const Any& value1,
        const Any& value2
        );

    void
    notice(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3
        );

    void
    notice(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4
        );

    void
    notice(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5
        );

    void
    notice(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6
        );

    void
    notice(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6,
        const Any& value7
        );

    void
    notice(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6,
        const Any& value7,
        const Any& value8
        );

    void
    notice(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6,
        const Any& value7,
        const Any& value8,
        const Any& value9
        );

    void
    notice(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6,
        const Any& value7,
        const Any& value8,
        const Any& value9,
        const Any& value10
        );

    void
    information(const std::string& msg);

    void
    information(
        const std::string& msg,
        const char* file,
        int line
        );

    void
    information(
        const std::string& fmt,
        const Any& value1
        );

    void
    information(
        const std::string& fmt,
        const Any& value1,
        const Any& value2
        );

    void
    information(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3
        );

    void
    information(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4
        );

    void
    information(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5
        );

    void
    information(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6
        );

    void
    information(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6,
        const Any& value7
        );

    void
    information(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6,
        const Any& value7,
        const Any& value8
        );

    void
    information(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6,
        const Any& value7,
        const Any& value8,
        const Any& value9
        );

    void
    information(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6,
        const Any& value7,
        const Any& value8,
        const Any& value9,
        const Any& value10
        );

    void
    debug(const std::string& msg);

    void
    debug(
        const std::string& msg,
        const char* file,
        int line
        );

    void
    debug(
        const std::string& fmt,
        const Any& value1
        );

    void
    debug(
        const std::string& fmt,
        const Any& value1,
        const Any& value2
        );

    void
    debug(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3
        );

    void
    debug(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4
        );

    void
    debug(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5
        );

    void
    debug(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6
        );

    void
    debug(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6,
        const Any& value7
        );

    void
    debug(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6,
        const Any& value7,
        const Any& value8
        );

    void
    debug(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6,
        const Any& value7,
        const Any& value8,
        const Any& value9
        );

    void
    debug(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6,
        const Any& value7,
        const Any& value8,
        const Any& value9,
        const Any& value10
        );

    void
    trace(const std::string& msg);

    void
    trace(
        const std::string& msg,
        const char* file,
        int line
        );

    void
    trace(
        const std::string& fmt,
        const Any& value1
        );

    void
    trace(
        const std::string& fmt,
        const Any& value1,
        const Any& value2
        );

    void
    trace(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3
        );

    void
    trace(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4
        );

    void
    trace(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5
        );

    void
    trace(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6
        );

    void
    trace(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6,
        const Any& value7
        );

    void
    trace(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6,
        const Any& value7,
        const Any& value8
        );

    void
    trace(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6,
        const Any& value7,
        const Any& value8,
        const Any& value9
        );

    void
    trace(
        const std::string& fmt,
        const Any& value1,
        const Any& value2,
        const Any& value3,
        const Any& value4,
        const Any& value5,
        const Any& value6,
        const Any& value7,
        const Any& value8,
        const Any& value9,
        const Any& value10
        );

    void
    dump(
        const std::string& msg,
        const void* buffer,
        std::size_t length,
        Message::Priority prio = Message::PRIO_DEBUG
        );

    bool
    is(int level) const;

    bool
    fatal() const;

    bool
    critical() const;

    bool
    error() const;

    bool
    warning() const;

    bool
    notice() const;

    bool
    information() const;

    bool
    debug() const;

    bool
    trace() const;

    static
    std::string
    format(
        const std::string& fmt,
        const std::string& arg
        );

    static
    std::string
    format(
        const std::string& fmt,
        const std::string& arg0,
        const std::string& arg1
        );

    static
    std::string
    format(
        const std::string& fmt,
        const std::string& arg0,
        const std::string& arg1,
        const std::string& arg2
        );

    static
    std::string
    format(
        const std::string& fmt,
        const std::string& arg0,
        const std::string& arg1,
        const std::string& arg2,
        const std::string& arg3
        );

    static
    void
    formatDump(
        std::string& message,
        const void* buffer,
        std::size_t length
        );

    static
    void
    setLevel(
        const std::string& name,
        int level
        );

    static
    void
    setChannel(
        const std::string& name,
        Channel* pChannel
        );

    static
    void
    setProperty(
        const std::string& loggerName,
        const std::string& propertyName,
        const std::string& value
        );

    static
    Logger&
    get(const std::string& name);

    static
    Logger&
    unsafeGet(const std::string& name);

    static
    Logger&
    create(
        const std::string& name,
        Channel* pChannel,
        int level = Message::PRIO_INFORMATION
        );

    static
    Logger&
    root();

    static
    Logger*
    has(const std::string& name);

    static
    void
    destroy(const std::string& name);

    static
    void
    shutdown();

    static
    void
    names(std::vector<std::string>& names);

    static
    int
    parseLevel(const std::string& level);

protected:
    // typedefs

    typedef std::map<std::string, Logger*> LoggerMap;

    // construction

    Logger(
        const std::string& name,
        Channel* pChannel,
        int level
        );

    // methods

    void
    log(
        const std::string& text,
        Message::Priority prio
        );

    void
    log(
        const std::string& text,
        Message::Priority prio,
        const char* file,
        int line
        );

    static
    std::string
    format(
        const std::string& fmt,
        int argc,
        std::string argv []
        );

    static
    Logger&
    parent(const std::string& name);

    static
    void
    add(Logger* pLogger);

    static
    Logger*
    find(const std::string& name);
};

Inherited Members

public:
    // methods

    virtual
    void
    setProperty(
        const std::string& name,
        const std::string& value
        ) = 0;

    virtual
    std::string
    getProperty(const std::string& name) const = 0;

    void
    duplicate() const;

    void
    release() const;

    int
    referenceCount() const;

    virtual
    void
    open();

    virtual
    void
    close();

    virtual
    void
    log(const Message& msg) = 0;

    virtual
    void
    setProperty(
        const std::string& name,
        const std::string& value
        );

    virtual
    std::string
    getProperty(const std::string& name) const;

Detailed Documentation

Logger is a special Channel that acts as the main entry point into the logging framework.

An application uses instances of the Logger class to generate its log messages and send them on their way to their final destination. Logger instances are organized in a hierarchical, tree-like manner and are maintained by the framework. Every Logger object has exactly one direct ancestor, with the exception of the root logger. A newly created logger inherits its properties - channel and level - from its direct ancestor. Every logger is connected to a channel, to which it passes on its messages. Furthermore, every logger has a log level, which is used for filtering messages based on their priority. Only messages with a priority equal to or higher than the specified level are passed on. For example, if the level of a logger is set to three (PRIO_ERROR), only messages with priority PRIO_ERROR, PRIO_CRITICAL and PRIO_FATAL will propagate. If the level is set to zero, the logger is effectively disabled.

The name of a logger determines the logger’s place within the logger hierarchy. The name of the root logger is always “”, the empty string. For all other loggers, the name is made up of one or more components, separated by a period. For example, the loggers with the name HTTPServer.RequestHandler and HTTPServer.Listener are descendants of the logger HTTPServer, which itself is a descendant of the root logger. There is not limit as to how deep the logger hierarchy can become. Once a logger has been created and it has inherited the channel and level from its ancestor, it loses the connection to it. So changes to the level or channel of a logger do not affect its descendants. This greatly simplifies the implementation of the framework and is no real restriction, because almost always levels and channels are set up at application startup and never changed afterwards. Nevertheless, there are methods to simultaneously change the level and channel of all loggers in a certain hierarchy.

There are also convenience macros available that wrap the actual logging statement into a check whether the Logger ‘s log level is sufficient to actually log the message. This allows to increase the application performance if many complex log statements are used. The macros also add the source file path and line number into the log message so that it is available to formatters. Variants of these macros that allow message formatting with Poco::format() are also available. Up to four arguments are supported.

Examples:

poco_warning(logger, "This is a warning");
poco_information_f2(logger, "An informational message with args: %d, %d", 1, 2);

Fields

static const std::string ROOT

The name of the root logger (“”).

Methods

const std::string&
name() const

Returns the name of the logger, which is set as the message source on all messages created by the logger.

void
setChannel(Channel* pChannel)

Attaches the given Channel to the Logger.

Channel*
getChannel() const

Returns the Channel attached to the logger.

void
setLevel(int level)

Sets the Logger ‘s log level.

See Message::Priority for valid log levels. Setting the log level to zero turns off logging for that Logger.

int
getLevel() const

Returns the Logger ‘s log level.

void
setLevel(const std::string& level)

Sets the Logger ‘s log level using a symbolic value.

Valid values are:

- none (turns off logging)
- fatal
- critical
- error
- warning
- notice
- information
- debug
- trace

virtual
void
setProperty(
    const std::string& name,
    const std::string& value
    )

Sets or changes a configuration property.

Only the “channel” and “level” properties are supported, which allow setting the target channel and log level, respectively, via the LoggingRegistry. The “channel” and “level” properties are set-only.

virtual
void
log(const Message& msg)

Logs the given message if its priority is greater than or equal to the Logger ‘s log level.

void
log(const Exception& exc)

Logs the given exception with priority PRIO_ERROR.

void
log(
    const Exception& exc,
    const char* file,
    int line
    )

Logs the given exception with priority PRIO_ERROR.

File must be a static string, such as the value of the FILE macro. The string is not copied internally for performance reasons.

void
fatal(const std::string& msg)

If the Logger ‘s log level is at least PRIO_FATAL, creates a Message with priority PRIO_FATAL and the given message text and sends it to the attached channel.

void
fatal(
    const std::string& msg,
    const char* file,
    int line
    )

If the Logger ‘s log level is at least PRIO_FATAL, creates a Message with priority PRIO_FATAL and the given message text and sends it to the attached channel.

File must be a static string, such as the value of the FILE macro. The string is not copied internally for performance reasons.

void
critical(const std::string& msg)

If the Logger ‘s log level is at least PRIO_CRITICAL, creates a Message with priority PRIO_CRITICAL and the given message text and sends it to the attached channel.

void
critical(
    const std::string& msg,
    const char* file,
    int line
    )

If the Logger ‘s log level is at least PRIO_CRITICAL, creates a Message with priority PRIO_CRITICAL and the given message text and sends it to the attached channel.

File must be a static string, such as the value of the FILE macro. The string is not copied internally for performance reasons.

void
error(const std::string& msg)

If the Logger ‘s log level is at least PRIO_ERROR, creates a Message with priority PRIO_ERROR and the given message text and sends it to the attached channel.

void
error(
    const std::string& msg,
    const char* file,
    int line
    )

If the Logger ‘s log level is at least PRIO_ERROR, creates a Message with priority PRIO_ERROR and the given message text and sends it to the attached channel.

File must be a static string, such as the value of the FILE macro. The string is not copied internally for performance reasons.

void
warning(const std::string& msg)

If the Logger ‘s log level is at least PRIO_WARNING, creates a Message with priority PRIO_WARNING and the given message text and sends it to the attached channel.

void
warning(
    const std::string& msg,
    const char* file,
    int line
    )

If the Logger ‘s log level is at least PRIO_WARNING, creates a Message with priority PRIO_WARNING and the given message text and sends it to the attached channel.

File must be a static string, such as the value of the FILE macro. The string is not copied internally for performance reasons.

void
notice(const std::string& msg)

If the Logger ‘s log level is at least PRIO_NOTICE, creates a Message with priority PRIO_NOTICE and the given message text and sends it to the attached channel.

void
notice(
    const std::string& msg,
    const char* file,
    int line
    )

If the Logger ‘s log level is at least PRIO_NOTICE, creates a Message with priority PRIO_NOTICE and the given message text and sends it to the attached channel.

File must be a static string, such as the value of the FILE macro. The string is not copied internally for performance reasons.

void
information(const std::string& msg)

If the Logger ‘s log level is at least PRIO_INFORMATION, creates a Message with priority PRIO_INFORMATION and the given message text and sends it to the attached channel.

void
information(
    const std::string& msg,
    const char* file,
    int line
    )

If the Logger ‘s log level is at least PRIO_INFORMATION, creates a Message with priority PRIO_INFORMATION and the given message text and sends it to the attached channel.

File must be a static string, such as the value of the FILE macro. The string is not copied internally for performance reasons.

void
debug(const std::string& msg)

If the Logger ‘s log level is at least PRIO_DEBUG, creates a Message with priority PRIO_DEBUG and the given message text and sends it to the attached channel.

void
debug(
    const std::string& msg,
    const char* file,
    int line
    )

If the Logger ‘s log level is at least PRIO_DEBUG, creates a Message with priority PRIO_DEBUG and the given message text and sends it to the attached channel.

File must be a static string, such as the value of the FILE macro. The string is not copied internally for performance reasons.

void
trace(const std::string& msg)

If the Logger ‘s log level is at least PRIO_TRACE, creates a Message with priority PRIO_TRACE and the given message text and sends it to the attached channel.

void
trace(
    const std::string& msg,
    const char* file,
    int line
    )

If the Logger ‘s log level is at least PRIO_TRACE, creates a Message with priority PRIO_TRACE and the given message text and sends it to the attached channel.

File must be a static string, such as the value of the FILE macro. The string is not copied internally for performance reasons.

void
dump(
    const std::string& msg,
    const void* buffer,
    std::size_t length,
    Message::Priority prio = Message::PRIO_DEBUG
    )

Logs the given message, followed by the data in buffer.

The data in buffer is written in canonical hex+ASCII form: Offset (4 bytes) in hexadecimal, followed by sixteen space-separated, two column, hexadecimal bytes, followed by the same sixteen bytes as ASCII characters. For bytes outside the range 32 .. 127, a dot is printed.

bool
is(int level) const

Returns true if at least the given log level is set.

bool
fatal() const

Returns true if the log level is at least PRIO_FATAL.

bool
critical() const

Returns true if the log level is at least PRIO_CRITICAL.

bool
error() const

Returns true if the log level is at least PRIO_ERROR.

bool
warning() const

Returns true if the log level is at least PRIO_WARNING.

bool
notice() const

Returns true if the log level is at least PRIO_NOTICE.

bool
information() const

Returns true if the log level is at least PRIO_INFORMATION.

bool
debug() const

Returns true if the log level is at least PRIO_DEBUG.

bool
trace() const

Returns true if the log level is at least PRIO_TRACE.

static
std::string
format(
    const std::string& fmt,
    const std::string& arg
    )

Replaces all occurences of $0 in fmt with the string given in arg and returns the result.

To include a dollar sign in the result string, specify two dollar signs ($$) in the format string.

static
std::string
format(
    const std::string& fmt,
    const std::string& arg0,
    const std::string& arg1
    )

Replaces all occurences of $<n> in fmt with the string given in arg<n> and returns the result.

To include a dollar sign in the result string, specify two dollar signs ($$) in the format string.

static
std::string
format(
    const std::string& fmt,
    const std::string& arg0,
    const std::string& arg1,
    const std::string& arg2
    )

Replaces all occurences of $<n> in fmt with the string given in arg<n> and returns the result.

To include a dollar sign in the result string, specify two dollar signs ($$) in the format string.

static
std::string
format(
    const std::string& fmt,
    const std::string& arg0,
    const std::string& arg1,
    const std::string& arg2,
    const std::string& arg3
    )

Replaces all occurences of $<n> in fmt with the string given in arg<n> and returns the result.

To include a dollar sign in the result string, specify two dollar signs ($$) in the format string.

static
void
formatDump(
    std::string& message,
    const void* buffer,
    std::size_t length
    )

Creates a hex-dump of the given buffer and appends it to the given message string.

static
void
setLevel(
    const std::string& name,
    int level
    )

Sets the given log level on all loggers that are descendants of the Logger with the given name.

static
void
setChannel(
    const std::string& name,
    Channel* pChannel
    )

Attaches the given Channel to all loggers that are descendants of the Logger with the given name.

static
void
setProperty(
    const std::string& loggerName,
    const std::string& propertyName,
    const std::string& value
    )

Sets or changes a configuration property for all loggers that are descendants of the Logger with the given name.

static
Logger&
get(const std::string& name)

Returns a reference to the Logger with the given name.

If the Logger does not yet exist, it is created, based on its parent logger.

static
Logger&
unsafeGet(const std::string& name)

Returns a reference to the Logger with the given name.

If the Logger does not yet exist, it is created, based on its parent logger.

WARNING: This method is not thread safe. You should probably use get() instead. The only time this method should be used is during program initialization, when only one thread is running.

static
Logger&
create(
    const std::string& name,
    Channel* pChannel,
    int level = Message::PRIO_INFORMATION
    )

Creates and returns a reference to a Logger with the given name.

The Logger ‘s Channel and log level as set as specified.

static
Logger&
root()

Returns a reference to the root logger, which is the ultimate ancestor of all Loggers.

static
Logger*
has(const std::string& name)

Returns a pointer to the Logger with the given name if it exists, or a null pointer otherwse.

static
void
destroy(const std::string& name)

Destroys the logger with the specified name.

Does nothing if the logger is not found.

After a logger has been destroyed, all references to it become invalid.

static
void
shutdown()

Shuts down the logging framework and releases all Loggers.

static
void
names(std::vector<std::string>& names)

Fills the given vector with the names of all currently defined loggers.

static
int
parseLevel(const std::string& level)

Parses a symbolic log level from a string and returns the resulting numeric level.

Valid symbolic levels are:

- none (turns off logging)
- fatal
- critical
- error
- warning
- notice
- information
- debug
- trace

The level is not case sensitive.