log4cplus Namespace Reference

Compounds
class	Appender
	Extend this class for implementing your own strategies for printing log statements. More...
class	BasicConfigurator
	Use this class to quickly configure the package. More...
class	ConfigureAndWatchThread
class	ConsoleAppender
	ConsoleAppender appends log events to System.out or System.err using a layout specified by the user. More...
class	DailyRollingFileAppender
	DailyRollingFileAppender extends FileAppender so that the underlying file is rolled over at a user chosen frequency. More...
class	DefaultLoggerFactory
	This class is used to create the default implementation of the Logger class. More...
struct	DiagnosticContext
	This is the internal object that is stored on the NDC stack. More...
class	ErrorHandler
	This class is used to "handle" errors encountered in an Appender. More...
class	FileAppender
	Appends log events to a file. More...
class	Hierarchy
	This class is specialized in retrieving loggers by name and also maintaining the logger hierarchy. More...
class	HierarchyLocker
	This is used to lock a Hierarchy. More...
class	Layout
	This class is used to layout strings sent to an Appender. More...
class	Logger
	This is the central class in the log4cplus package. More...
class	LogLevelManager
	This class is used to "manage" LogLevel definitions. More...
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 "<i>Pattern Languages of Program Design 3</i>" edited by Martin et al. More...
class	NDCContextCreator
	This class ensures that a NDC#push call is always matched with a NDC#pop call even in the face of exceptions. More...
class	NullAppender
	Appends log events to a file. More...
class	OnlyOnceErrorHandler
class	PatternLayout
	A flexible layout configurable with pattern string. More...
class	PropertyConfigurator
	Provides configuration from an external file. More...
class	RollingFileAppender
	RollingFileAppender extends FileAppender to backup the log files when they reach a certain size. More...
class	SimpleLayout
	SimpleLayout consists of the LogLevel of the log statement, followed by " - " and then the log message itself. More...
class	SocketAppender
	Sends LoggingEvent objects to a remote a log server. More...
class	tostringstream
class	TraceLogger
	This class is used to produce "Trace" logging. More...
class	TTCCLayout
	TTCC layout format consists of time, thread, Logger and nested diagnostic context information, hence the name. More...
Typedefs
typedef LOG4CPLUS_FSTREAM_NAMESPACE::ofstream	tofstream
typedef LOG4CPLUS_FSTREAM_NAMESPACE::ifstream	tifstream
typedef std::vector< Logger >	LoggerList
typedef int	LogLevel
typedef 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::stack< DiagnosticContext >	DiagnosticContextStack
typedef std::vector< log4cplus::SharedAppenderPtr >	SharedAppenderPtrList
typedef LOG4CPLUS_STREAM_NAMESPACE::ostream	tostream
typedef LOG4CPLUS_STREAM_NAMESPACE::istream	tistream
typedef char	tchar
typedef std::string	tstring
Enumerations
enum	DailyRollingFileSchedule {   MONTHLY, WEEKLY, DAILY, TWICE_DAILY,   HOURLY, MINUTELY }
Functions
LOG4CPLUS_EXPORT LogLevelManager &	getLogLevelManager ()
	Returns the singleton LogLevelManager.
LOG4CPLUS_EXPORT NDC &	getNDC ()
	Return a reference to the singleton object.
Variables
This is a pointer to an Appender.typedef helpers::SharedObjectPtr< Appender >	SharedAppenderPtr
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
tostream &	tcout = LOG4CPLUS_STREAM_NAMESPACE::cout
tostream &	tcerr = LOG4CPLUS_STREAM_NAMESPACE::cerr

---

Typedef Documentation

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

Definition at line 38 of file ndc.h.

typedef std::vector<Logger> log4cplus::LoggerList

Definition at line 46 of file logger.h.

typedef int log4cplus::LogLevel

Definition at line 36 of file loglevel.h. Referenced by log4cplus::spi::InternalLoggingEvent::getLogLevel(), log4cplus::spi::LoggerImpl::getLogLevel(), and log4cplus::Appender::getThreshold().

typedef 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 92 of file loglevel.h.

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

Definition at line 28 of file appenderattachable.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 100 of file loglevel.h.

typedef char log4cplus::tchar

Definition at line 47 of file tstring.h.

typedef LOG4CPLUS_FSTREAM_NAMESPACE::ifstream log4cplus::tifstream

Definition at line 38 of file fstreams.h.

typedef LOG4CPLUS_STREAM_NAMESPACE::istream log4cplus::tistream

Definition at line 54 of file streams.h.

typedef LOG4CPLUS_FSTREAM_NAMESPACE::ofstream log4cplus::tofstream

Definition at line 37 of file fstreams.h.

typedef LOG4CPLUS_STREAM_NAMESPACE::ostream log4cplus::tostream

Definition at line 53 of file streams.h.

typedef std::string log4cplus::tstring

Definition at line 48 of file tstring.h. Referenced by log4cplus::helpers::convertIntegerToString(), log4cplus::spi::InternalLoggingEvent::InternalLoggingEvent(), and log4cplus::tostringstream::str().

---

Enumeration Type Documentation

enum log4cplus::DailyRollingFileSchedule

Enumeration values: MONTHLY  WEEKLY  DAILY  TWICE_DAILY  HOURLY  MINUTELY  Definition at line 112 of file fileappender.h.

---

Function Documentation

LOG4CPLUS_EXPORT LogLevelManager& getLogLevelManager (   )

Returns the singleton LogLevelManager. Referenced by log4cplus::Layout::Layout().

LOG4CPLUS_EXPORT NDC& getNDC (   )

Return a reference to the singleton object. Referenced by log4cplus::spi::InternalLoggingEvent::getNDC(), log4cplus::spi::InternalLoggingEvent::InternalLoggingEvent(), log4cplus::NDCContextCreator::NDCContextCreator(), and log4cplus::NDCContextCreator::~NDCContextCreator().

---

Variable Documentation

const LogLevel log4cplus::ALL_LOG_LEVEL = TRACE_LOG_LEVEL

Definition at line 77 of file loglevel.h.

const LogLevel log4cplus::DEBUG_LOG_LEVEL = 10000

Definition at line 67 of file loglevel.h.

const LogLevel log4cplus::ERROR_LOG_LEVEL = 40000

Definition at line 51 of file loglevel.h.

const LogLevel log4cplus::FATAL_LOG_LEVEL = 50000

Definition at line 46 of file loglevel.h. Referenced by log4cplus::Logger::assertion().

const LogLevel log4cplus::INFO_LOG_LEVEL = 20000

Definition at line 62 of file loglevel.h.

const LogLevel log4cplus::NOT_SET_LOG_LEVEL = -1

Definition at line 83 of file loglevel.h. Referenced by log4cplus::Appender::isAsSevereAsThreshold().

const LogLevel log4cplus::OFF_LOG_LEVEL = 60000

Definition at line 41 of file loglevel.h.

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

Definition at line 27 of file appenderattachable.h.

tostream& log4cplus::tcerr = LOG4CPLUS_STREAM_NAMESPACE::cerr [static]

Definition at line 56 of file streams.h.

tostream& log4cplus::tcout = LOG4CPLUS_STREAM_NAMESPACE::cout [static]

Definition at line 55 of file streams.h.

const LogLevel log4cplus::TRACE_LOG_LEVEL = 0

Definition at line 72 of file loglevel.h. Referenced by log4cplus::TraceLogger::TraceLogger(), and log4cplus::TraceLogger::~TraceLogger().

const LogLevel log4cplus::WARN_LOG_LEVEL = 30000

Definition at line 56 of file loglevel.h.

---