Apache Qpid - AMQP Messaging for Java JMS, C++, Python, Ruby, and .NET Apache Qpid Documentation
Classes | Namespaces | Defines | Enumerations
qpid/log/Statement.h File Reference
#include "qpid/Msg.h"
#include "qpid/CommonImportExport.h"
#include <boost/current_function.hpp>

Go to the source code of this file.

Classes

struct  qpid::log::LevelTraits
struct  qpid::log::Statement
 POD struct representing a logging statement in source code. More...
struct  qpid::log::Statement::Initializer

Namespaces

namespace  qpid
 

This file was automatically generated from the AMQP specification.


namespace  qpid::log

Defines

#define QPID_LOG_STATEMENT_INIT(level)   { 0, __FILE__, __LINE__, BOOST_CURRENT_FUNCTION, (::qpid::log::level) }
#define QPID_LOG_IF(LEVEL, TEST, MESSAGE)
 Like QPID_LOG but computes an additional boolean test expression to determine if the message should be logged.
#define QPID_LOG_TEST(LEVEL, FLAG)
 FLAG must be a boolean variable.
#define QPID_LOG(LEVEL, MESSAGE)   QPID_LOG_IF(LEVEL, true, MESSAGE);
 Macro for log statements.

Enumerations

enum  qpid::log::Level {
  qpid::log::trace, qpid::log::debug, qpid::log::info, qpid::log::notice,
  qpid::log::warning, qpid::log::error, qpid::log::critical
}
 Debugging severity levels. More...

Define Documentation

#define QPID_LOG (   LEVEL,
  MESSAGE 
)    QPID_LOG_IF(LEVEL, true, MESSAGE);

Macro for log statements.

Example of use:

 QPID_LOG(debug, "There are " << foocount << " foos in the bar.");
 QPID_LOG(error, boost::format("Dohickey %s exploded") % dohicky.name());

You can subscribe to log messages by level, by component, by filename or a combination

See also:
Configuration.
Parameters:
LEVELseverity Level for message, should be one of: debug, info, notice, warning, error, critical. NB no qpid::log:: prefix.
MESSAGEany object with an operator<<, or a sequence like of ostreamable objects separated by <<.

Definition at line 131 of file Statement.h.

#define QPID_LOG_IF (   LEVEL,
  TEST,
  MESSAGE 
)
Value:
do {                                                        \
        using ::qpid::log::Statement;                           \
        static Statement stmt_= QPID_LOG_STATEMENT_INIT(LEVEL); \
        static Statement::Initializer init_(stmt_);             \
        if (stmt_.enabled && (TEST))                            \
            stmt_.log(::qpid::Msg() << MESSAGE);                \
    } while(0)

Like QPID_LOG but computes an additional boolean test expression to determine if the message should be logged.

Evaluation of both the test and message expressions occurs only if the requested log level is enabled.

Parameters:
LEVELseverity Level for message, should be one of: debug, info, notice, warning, error, critical. NB no qpid::log:: prefix.
TESTmessage is logged only if expression TEST evaluates to true.
MESSAGEany object with an operator<<, or a sequence like of ostreamable objects separated by <<.

Definition at line 89 of file Statement.h.

#define QPID_LOG_STATEMENT_INIT (   level)    { 0, __FILE__, __LINE__, BOOST_CURRENT_FUNCTION, (::qpid::log::level) }

Definition at line 75 of file Statement.h.

#define QPID_LOG_TEST (   LEVEL,
  FLAG 
)
Value:
do {                                                        \
        using ::qpid::log::Statement;                           \
        static Statement stmt_= QPID_LOG_STATEMENT_INIT(LEVEL); \
        static Statement::Initializer init_(stmt_);             \
        FLAG = stmt_.enabled;                                   \
    } while(0)

FLAG must be a boolean variable.

Assigns FLAG to true iff logging is enabled for LEVEL in the calling context. Use when extra support code is needed to generate log messages, to ensure that it is only run if the logging level is enabled. e.g. bool logWarning; QPID_LOG_TEST(LEVEL, logWarning); if (logWarning) { do stuff needed for warning log messages }

Definition at line 108 of file Statement.h.


Qpid C++ API Reference
Generated on Mon Aug 22 2011 for Qpid C++ Client API by doxygen 1.7.4