Namespaces

detail
device_appender_detail
helpers
internal
pattern
spi
thread

Classes

class Appender
Extend this class for implementing your own strategies for printing log statements. class AsyncAppender
This Appender is a wrapper to which other appenders can be attached. class BasicConfigurator
Use this class to quickly configure the package. class CallbackAppender
Send log events to a C function callback. class CLFSAppender
class ConfigureAndWatchThread
class ConsoleAppender
ConsoleAppender appends log events to std::cout or std::cerr using a layout specified by the user. class DailyRollingFileAppender
DailyRollingFileAppender extends FileAppender so that the underlying file is rolled over at a user chosen frequency. class DefaultLoggerFactory
This class is used to create the default implementation of the Logger class. class DeviceAppender
struct DiagnosticContext
This is the internal object that is stored on the NDC stack. class ErrorHandler
This class is used to 'handle' errors encountered in an {}. class FileAppender
Appends log events to a file. class FileAppenderBase
Base class for Appenders writing log events to a file. class Hierarchy
This class is specialized in retrieving loggers by name and also maintaining the logger hierarchy. class HierarchyLocker
This is used to lock a Hierarchy. class Initializer
This class helps with initialization and shutdown of log4cplus. class Layout
This class is used to layout strings sent to an {}. class Log4jUdpAppender
Sends log events as Log4j XML to a remote a log server. class Logger
This is the central class in the log4cplus package. class LogLevelManager
This class is used to 'manage' LogLevel definitions. class MDC
class MSTTSAppender
class NDC
The NDC class implements nested diagnostic contexts as defined by Neil Harrison in the article 'Patterns for Logging Diagnostic Messages' part of the book 'Pattern Languages of Program Design 3' edited by Martin et al. " class NDCContextCreator
This class ensures that a NDC::push() call is always matched with a NDC::pop() call even in the face of exceptions. class NTEventLogAppender
Appends log events to NT EventLog. class NullAppender
Appends log events to a file. class OnlyOnceErrorHandler
class PatternLayout
A flexible layout configurable with pattern string. class PropertyConfigurator
Provides configuration from an external file. class Qt4DebugAppender
class Qt5DebugAppender
class RollingFileAppender
RollingFileAppender extends FileAppender to backup the log files when they reach a certain size. class SimpleLayout
SimpleLayout consists of the LogLevel of the log statement, followed by ' - ' and then the log message itself. class SocketAppender
Sends spi::InternalLoggingEvent objects to a remote a log server. class SysLogAppender
Appends log events to a file. class TimeBasedRollingFileAppender
TimeBasedRollingFileAppender extends FileAppenderBase so that the underlying file is rolled over at a user chosen frequency while also keeping in check a total maximum number of produced files. class TraceLogger
This class is used to produce 'Trace' logging. class TTCCLayout
TTCC layout format consists of time, thread, Logger and nested diagnostic context information, hence the name. class Win32ConsoleAppender
Prints events to Win32 console.

Typedefs

typedef helpers::SharedObjectPtr< Appender > SharedAppenderPtr
This is a pointer to an Appender. typedef helpers::SharedObjectPtr< AsyncAppender > AsyncAppenderPtr
typedef helpers::SharedObjectPtr< CLFSAppender > CLFSAppenderPtr
typedef helpers::SharedObjectPtr< FileAppender > SharedFileAppenderPtr
typedef helpers::SharedObjectPtr< RollingFileAppender > SharedRollingFileAppenderPtr
typedef helpers::SharedObjectPtr< DailyRollingFileAppender > SharedDailyRollingFileAppenderPtr
typedef helpers::SharedObjectPtr< TimeBasedRollingFileAppender > SharedTimeBasedRollingFileAppenderPtr
typedef std::basic_ofstream< tchar > tofstream
typedef std::basic_ifstream< tchar > tifstream
typedef std::vector< Logger > LoggerList
typedef int LogLevel
typedef const log4cplus::tstring &(* LogLevelToStringMethod) (LogLevel)
This method type defined the signature of methods that convert LogLevels into strings. typedef LogLevel(* StringToLogLevelMethod) (const log4cplus::tstring &)
This method type defined the signature of methods that convert strings into LogLevels. typedef std::map< tstring, tstring > MappedDiagnosticContextMap
typedef helpers::SharedObjectPtr< MSTTSAppender > MSTTSAppenderPtr
typedef std::deque< DiagnosticContext > DiagnosticContextStack
typedef helpers::SharedObjectPtr< Qt4DebugAppender > Qt4DebugAppenderPtr
typedef helpers::SharedObjectPtr< Qt5DebugAppender > Qt5DebugAppenderPtr
typedef std::vector< log4cplus::SharedAppenderPtr > SharedAppenderPtrList
typedef std::basic_ostream< tchar > tostream
typedef std::basic_istream< tchar > tistream
typedef std::basic_ostringstream< tchar > tostringstream
typedef std::basic_istringstream< tchar > tistringstream
typedef char tchar
typedef std::basic_string< tchar > tstring

Enumerations

enum DailyRollingFileSchedule { MONTHLY, WEEKLY, DAILY, TWICE_DAILY, HOURLY, MINUTELY }

Functions

template<typename T > SharedAppenderPtr make_device_appender (T &d, bool close_device=true)
template<typename T > SharedAppenderPtr make_device_appender (T &d, const helpers::Properties &props)
template<typename T > SharedAppenderPtr make_device_appender_sp (boost::shared_ptr< T > const &p, bool close_device=true)
template<typename T > SharedAppenderPtr make_device_appender_sp (boost::shared_ptr< T > const &p, const helpers::Properties &props)
LOG4CPLUS_EXPORT Hierarchy & getDefaultHierarchy ()
LOG4CPLUS_EXPORT const helpers::Time & getTTCCLayoutTimeBase ()
LOG4CPLUS_EXPORT LogLevelManager & getLogLevelManager ()
Returns the singleton LogLevelManager. LOG4CPLUS_EXPORT MDC & getMDC ()
LOG4CPLUS_EXPORT NDC & getNDC ()
Return a reference to the singleton object.

Variables

const LogLevel OFF_LOG_LEVEL = 60000
const LogLevel FATAL_LOG_LEVEL = 50000
const LogLevel ERROR_LOG_LEVEL = 40000
const LogLevel WARN_LOG_LEVEL = 30000
const LogLevel INFO_LOG_LEVEL = 20000
const LogLevel DEBUG_LOG_LEVEL = 10000
const LogLevel TRACE_LOG_LEVEL = 0
const LogLevel ALL_LOG_LEVEL = TRACE_LOG_LEVEL
const LogLevel NOT_SET_LOG_LEVEL = -1
const std::size_t LOG4CPLUS_MAX_MESSAGE_SIZE = 8*1024
LOG4CPLUS_EXPORT tostream & tcout
LOG4CPLUS_EXPORT tostream & tcerr
LOG4CPLUS_EXPORT const unsigned version
LOG4CPLUS_EXPORT const char versionStr []

typedef helpers::SharedObjectPtr<AsyncAppender> log4cplus::AsyncAppenderPtr

Definition at line 102 of file asyncappender.h.

typedef helpers::SharedObjectPtr<CLFSAppender> log4cplus::CLFSAppenderPtr

Definition at line 92 of file clfsappender.h.

typedef std::deque<DiagnosticContext> log4cplus::DiagnosticContextStack

Definition at line 43 of file ndc.h.

std::vector< Logger > log4cplus::LoggerList

This is a list of Loggers.

Definition at line 61 of file logger.h.

int log4cplus::LogLevel

Defines the minimum set of priorities recognized by the system, that is FATAL_LOG_LEVEL, ERROR_LOG_LEVEL, {}, #INFO_LOG_LEVEL}, #DEBUG_LOG_LEVEL}, and #TRACE_LOG_LEVEL}.

Definition at line 48 of file loglevel.h.

typedef const log4cplus::tstring&(* log4cplus::LogLevelToStringMethod) (LogLevel)

This method type defined the signature of methods that convert LogLevels into strings. Note: Must return an empty tstring for unrecognized values.

Definition at line 104 of file loglevel.h.

typedef std::map<tstring, tstring> log4cplus::MappedDiagnosticContextMap

Definition at line 43 of file mdc.h.

typedef helpers::SharedObjectPtr<MSTTSAppender> log4cplus::MSTTSAppenderPtr

Definition at line 106 of file msttsappender.h.

typedef helpers::SharedObjectPtr<Qt4DebugAppender> log4cplus::Qt4DebugAppenderPtr

Definition at line 97 of file qt4debugappender.h.

typedef helpers::SharedObjectPtr<Qt5DebugAppender> log4cplus::Qt5DebugAppenderPtr

Definition at line 97 of file qt5debugappender.h.

typedef helpers::SharedObjectPtr<Appender> log4cplus::SharedAppenderPtr

This is a pointer to an Appender.

Definition at line 336 of file appender.h.

typedef std::vector<log4cplus::SharedAppenderPtr> log4cplus::SharedAppenderPtrList

Definition at line 40 of file appenderattachable.h.

typedef helpers::SharedObjectPtr<DailyRollingFileAppender> log4cplus::SharedDailyRollingFileAppenderPtr

Definition at line 348 of file fileappender.h.

typedef helpers::SharedObjectPtr<FileAppender> log4cplus::SharedFileAppenderPtr

Definition at line 218 of file fileappender.h.

typedef helpers::SharedObjectPtr<RollingFileAppender> log4cplus::SharedRollingFileAppenderPtr

Definition at line 269 of file fileappender.h.

typedef helpers::SharedObjectPtr<TimeBasedRollingFileAppender> log4cplus::SharedTimeBasedRollingFileAppenderPtr

Definition at line 424 of file fileappender.h.

typedef LogLevel(* log4cplus::StringToLogLevelMethod) (const log4cplus::tstring &)

This method type defined the signature of methods that convert strings into LogLevels. Note: Must return NOT_SET_LOG_LEVEL for unrecognized values.

Definition at line 113 of file loglevel.h.

typedef char log4cplus::tchar

Definition at line 56 of file tchar.h.

typedef std::basic_ifstream<tchar> log4cplus::tifstream

Definition at line 42 of file fstreams.h.

typedef std::basic_istream<tchar> log4cplus::tistream

Definition at line 41 of file streams.h.

typedef std::basic_istringstream<tchar> log4cplus::tistringstream

Definition at line 43 of file streams.h.

typedef std::basic_ofstream<tchar> log4cplus::tofstream

Definition at line 41 of file fstreams.h.

typedef std::basic_ostream<tchar> log4cplus::tostream

Definition at line 40 of file streams.h.

typedef std::basic_ostringstream<tchar> log4cplus::tostringstream

Definition at line 42 of file streams.h.

typedef std::basic_string<tchar> log4cplus::tstring

Definition at line 39 of file tstring.h.

enum log4cplus::DailyRollingFileSchedule

Enumerator

MONTHLY

WEEKLY

DAILY

TWICE_DAILY

HOURLY

MINUTELY

Definition at line 272 of file fileappender.h.

LOG4CPLUS_EXPORT Hierarchy& log4cplus::getDefaultHierarchy ()

LOG4CPLUS_EXPORT LogLevelManager& log4cplus::getLogLevelManager ()

Returns the singleton LogLevelManager.

Referenced by log4cplus::internal::CustomLogLevelManager::add().

LOG4CPLUS_EXPORT MDC& log4cplus::getMDC ()

Referenced by log4cplus::spi::InternalLoggingEvent::getMDCCopy().

LOG4CPLUS_EXPORT NDC& log4cplus::getNDC ()

Return a reference to the singleton object.

Referenced by log4cplus::spi::InternalLoggingEvent::getNDC().

LOG4CPLUS_EXPORT const helpers::Time& log4cplus::getTTCCLayoutTimeBase ()

template<typename T > SharedAppenderPtr log4cplus::make_device_appender (T & d, bool close_device = true) [inline]

Definition at line 157 of file deviceappender.hxx.

template<typename T > SharedAppenderPtr log4cplus::make_device_appender (T & d, const helpers::Properties & props) [inline]

Definition at line 167 of file deviceappender.hxx.

template<typename T > SharedAppenderPtr log4cplus::make_device_appender_sp (boost::shared_ptr< T > const & p, bool close_device = true) [inline]

Definition at line 177 of file deviceappender.hxx.

template<typename T > SharedAppenderPtr log4cplus::make_device_appender_sp (boost::shared_ptr< T > const & p, const helpers::Properties & props) [inline]

Definition at line 189 of file deviceappender.hxx.

const LogLevel log4cplus::ALL_LOG_LEVEL = TRACE_LOG_LEVEL

The ALL_LOG_LEVEL LogLevel is used during configuration to turn on all logging.

Definition at line 89 of file loglevel.h.

const LogLevel log4cplus::DEBUG_LOG_LEVEL = 10000

The DEBUG_LOG_LEVEL LogLevel designates fine-grained informational events that are most useful to debug an application.

Definition at line 79 of file loglevel.h.

const LogLevel log4cplus::ERROR_LOG_LEVEL = 40000

The ERROR_LOG_LEVEL LogLevel designates error events that might still allow the application to continue running.

Definition at line 63 of file loglevel.h.

const LogLevel log4cplus::FATAL_LOG_LEVEL = 50000

The FATAL_LOG_LEVEL LogLevel designates very severe error events that will presumably lead the application to abort.

Definition at line 58 of file loglevel.h.

const LogLevel log4cplus::INFO_LOG_LEVEL = 20000

The INFO_LOG_LEVEL LogLevel designates informational messages that highlight the progress of the application at coarse-grained level.

Definition at line 74 of file loglevel.h.

const std::size_t log4cplus::LOG4CPLUS_MAX_MESSAGE_SIZE = 8*1024

Definition at line 44 of file socketappender.h.

const LogLevel log4cplus::NOT_SET_LOG_LEVEL = -1

The NOT_SET_LOG_LEVEL LogLevel is used to indicated that no particular LogLevel is desired and that the default should be used.

Definition at line 95 of file loglevel.h.

Referenced by log4cplus::internal::CustomLogLevelManager::customFromStringMethodWorker(), and log4cplus::Appender::isAsSevereAsThreshold().

const LogLevel log4cplus::OFF_LOG_LEVEL = 60000

The OFF_LOG_LEVEL LogLevel is used during configuration to turn off logging.

Definition at line 53 of file loglevel.h.

LOG4CPLUS_EXPORT tostream& log4cplus::tcerr

LOG4CPLUS_EXPORT tostream& log4cplus::tcout

const LogLevel log4cplus::TRACE_LOG_LEVEL = 0

The TRACE_LOG_LEVEL LogLevel is used to 'trace' entry and exiting of methods.

Definition at line 84 of file loglevel.h.

Referenced by log4cplus::TraceLogger::TraceLogger(), and log4cplus::TraceLogger::~TraceLogger().

LOG4CPLUS_EXPORT const unsigned log4cplus::version

LOG4CPLUS_EXPORT const char log4cplus::versionStr[]

const LogLevel log4cplus::WARN_LOG_LEVEL = 30000

The WARN_LOG_LEVEL LogLevel designates potentially harmful situations.

Definition at line 68 of file loglevel.h.