log4cpp::Category - Man Page

virtual ~Category ()
Destructor for Category.
virtual const std::string & getName () const  throw ()
Return the category name.
virtual void setPriority (Priority::Value priority)
Set the priority of this Category.
virtual Priority::Value getPriority () const  throw ()
Returns the assigned Priority, if any, for this Category.
virtual Priority::Value getChainedPriority () const  throw ()
Starting from this Category, search the category hierarchy for a set priority and return it.
virtual bool isPriorityEnabled (Priority::Value priority) const  throw ()
Returns true if the chained priority of the Category is equal to or higher than given priority.
virtual void addAppender (Appender *appender)
Adds an Appender to this Category.
virtual void addAppender (Appender &appender)
Adds an Appender for this Category.
void setAppender (Appender *appender)
Adds an Appender to this Category.
void setAppender (Appender &appender)
Adds an Appender for this Category.
virtual Appender * getAppender () const
Returns the first Appender for this Category, or NULL if no Appender has been set.
virtual Appender * getAppender (const std::string &name) const
Returns the specified Appender for this Category, or NULL if the Appender is not attached to this Category.
virtual AppenderSet getAllAppenders () const
Returns the set of Appenders currently attached to this Catogory.
virtual void removeAllAppenders ()
Removes all appenders for this Category.
virtual void removeAppender (Appender *appender)
Removes specified appender for this Category.
virtual bool ownsAppender () const  throw ()
Returns true if the Category owns the first Appender in its Appender set.
virtual bool ownsAppender (Appender *appender) const  throw ()
Returns true if the Category owns the Appender.
virtual void callAppenders (const LoggingEvent &event)  throw ()
Call the appenders in the hierarchy starting at this.
virtual void setAdditivity (bool additivity)
Set the additivity flag for this Category instance.
virtual bool getAdditivity () const  throw ()
Returns the additivity flag for this Category instance.
virtual Category * getParent ()  throw ()
Returns the parent category of this category, or NULL if the category is the root category.
virtual const Category * getParent () const  throw ()
Returns the parent category of this category, or NULL if the category is the root category.
virtual void log (Priority::Value priority, const char *stringFormat,...)  throw ()
Log a message with the specified priority.
virtual void log (Priority::Value priority, const std::string &message)  throw ()
Log a message with the specified priority.
virtual void logva (Priority::Value priority, const char *stringFormat, va_list va)  throw ()
Log a message with the specified priority.
void debug (const char *stringFormat,...)  throw ()
Log a message with debug priority.
void debug (const std::string &message)  throw ()
Log a message with debug priority.
bool isDebugEnabled () const  throw ()
Return true if the Category will log messages with priority DEBUG.
CategoryStream debugStream ()
Return a CategoryStream with priority DEBUG.
void info (const char *stringFormat,...)  throw ()
Log a message with info priority.
void info (const std::string &message)  throw ()
Log a message with info priority.
bool isInfoEnabled () const  throw ()
Return true if the Category will log messages with priority INFO.
CategoryStream infoStream ()
Return a CategoryStream with priority INFO.
void notice (const char *stringFormat,...)  throw ()
Log a message with notice priority.
void notice (const std::string &message)  throw ()
Log a message with notice priority.
bool isNoticeEnabled () const  throw ()
Return true if the Category will log messages with priority NOTICE.
CategoryStream noticeStream ()
Return a CategoryStream with priority NOTICE.
void warn (const char *stringFormat,...)  throw ()
Log a message with warn priority.
void warn (const std::string &message)  throw ()
Log a message with warn priority.
bool isWarnEnabled () const  throw ()
Return true if the Category will log messages with priority WARN.
CategoryStream warnStream ()
Return a CategoryStream with priority WARN.
void error (const char *stringFormat,...)  throw ()
Log a message with error priority.
void error (const std::string &message)  throw ()
Log a message with error priority.
bool isErrorEnabled () const  throw ()
Return true if the Category will log messages with priority ERROR.
CategoryStream errorStream ()
Return a CategoryStream with priority ERROR.
void crit (const char *stringFormat,...)  throw ()
Log a message with crit priority.
void crit (const std::string &message)  throw ()
Log a message with crit priority.
bool isCritEnabled () const  throw ()
Return true if the Category will log messages with priority CRIT.
CategoryStream critStream ()
Return a CategoryStream with priority CRIT.
void alert (const char *stringFormat,...)  throw ()
Log a message with alert priority.
void alert (const std::string &message)  throw ()
Log a message with alert priority.
bool isAlertEnabled () const  throw ()
Return true if the Category will log messages with priority ALERT.
CategoryStream alertStream ()  throw ()
Return a CategoryStream with priority ALERT.
void emerg (const char *stringFormat,...)  throw ()
Log a message with emerg priority.
void emerg (const std::string &message)  throw ()
Log a message with emerg priority.
bool isEmergEnabled () const  throw ()
Return true if the Category will log messages with priority EMERG.
CategoryStream emergStream ()
Return a CategoryStream with priority EMERG.
void fatal (const char *stringFormat,...)  throw ()
Log a message with fatal priority.
void fatal (const std::string &message)  throw ()
Log a message with fatal priority.
bool isFatalEnabled () const  throw ()
Return true if the Category will log messages with priority FATAL.
CategoryStream fatalStream ()
Return a CategoryStream with priority FATAL.
virtual CategoryStream getStream (Priority::Value priority)
Return a CategoryStream with given Priority.
virtual CategoryStream operator<< (Priority::Value priority)
Return a CategoryStream with given Priority.

static Category & getRoot ()
Return the root of the Category hierarchy.
static void setRootPriority (Priority::Value priority)
Set the priority of the root Category.
static Priority::Value getRootPriority ()  throw ()
Get the priority of the root Category.
static Category & getInstance (const std::string &name)
Instantiate a Category with name name.
static Category * exists (const std::string &name)
If the named category exists (in the default hierarchy) then it returns a reference to the category, otherwise it returns NULL.
static std::vector< Category * > * getCurrentCategories ()
Returns all the currently defined categories as a vector of Category pointers.
static void shutdown ()
This method will remove all Appenders from Categories.XXX.
static void shutdownForced ()
This method will remove all Appenders from Categories.XXX and delete all appenders.

Category (const std::string &name, Category *parent, Priority::Value priority=Priority::NOTSET)
Constructor.
virtual void _logUnconditionally (Priority::Value priority, const char *format, va_list arguments)  throw ()
virtual void _logUnconditionally2 (Priority::Value priority, const std::string &message)  throw ()
Unconditionally log a message with the specified priority.

class HierarchyMaintainer

Destructor for Category.

Constructor.

Parameters

name the fully qualified name of this Category
parent the parent of this parent, or NULL for the root Category
priority the priority for this Category. Defaults to Priority::NOTSET

Unconditionally log a message with the specified priority.

Parameters

priority The priority of this log message.
message string to write in the log file

Reimplemented in log4cpp::FixedContextCategory.

Adds an Appender for this Category. This method does not pass ownership from the caller to the Category.

Since

Parameters

appender The Appender this category has to log to.

Reimplemented in log4cpp::FixedContextCategory.

Adds an Appender to this Category. This method passes ownership from the caller to the Category.

Since

Parameters

appender The Appender to wich this category has to log.

Exceptions

std::invalid_argument if the appender is NULL.

Reimplemented in log4cpp::FixedContextCategory.

Log a message with alert priority.

Parameters

stringFormat Format specifier for the string to write in the log file.
... The arguments for stringFormat

Log a message with alert priority.

Parameters

message string to write in the log file

Return a CategoryStream with priority ALERT.

Returns

The CategoryStream.

Call the appenders in the hierarchy starting at this. If no appenders could be found, emit a warning.

This method always calls all the appenders inherited form the hierracy circumventing any evaluation of whether to log or not to log the particular log request.

Parameters

event the LogginEvent to log.

Reimplemented in log4cpp::FixedContextCategory.

Log a message with crit priority.

Parameters

stringFormat Format specifier for the string to write in the log file.
... The arguments for stringFormat

Log a message with crit priority.

Parameters

message string to write in the log file

Return a CategoryStream with priority CRIT.

Returns

The CategoryStream.

Log a message with debug priority.

Parameters

stringFormat Format specifier for the string to write in the log file.
... The arguments for stringFormat

Log a message with debug priority.

Parameters

message string to write in the log file

Return a CategoryStream with priority DEBUG.

Returns

The CategoryStream.

Log a message with emerg priority.

Parameters

stringFormat Format specifier for the string to write in the log file.
... The arguments for stringFormat

Log a message with emerg priority.

Parameters

message string to write in the log file

Return a CategoryStream with priority EMERG.

Returns

The CategoryStream.

Log a message with error priority.

Parameters

stringFormat Format specifier for the string to write in the log file.
... The arguments for stringFormat

Log a message with error priority.

Parameters

message string to write in the log file

Return a CategoryStream with priority ERROR.

Returns

The CategoryStream.

If the named category exists (in the default hierarchy) then it returns a reference to the category, otherwise it returns NULL.

Since

Log a message with fatal priority. NB. priority 'fatal' is equivalent to 'emerg'.

Since

Parameters

stringFormat Format specifier for the string to write in the log file.
... The arguments for stringFormat

Log a message with fatal priority. NB. priority 'fatal' is equivalent to 'emerg'.

Since

Parameters

message string to write in the log file

Return a CategoryStream with priority FATAL. NB. priority 'fatal' is equivalent to 'emerg'.

Since

Returns

The CategoryStream.

Returns the additivity flag for this Category instance.

Reimplemented in log4cpp::FixedContextCategory.

Returns the set of Appenders currently attached to this Catogory.

Since

Returns

The set of attached Appenders.

Reimplemented in log4cpp::FixedContextCategory.

Returns the first Appender for this Category, or NULL if no Appender has been set.

Deprecated

use getAppender(const std::string&)

Returns

The Appender.

Reimplemented in log4cpp::FixedContextCategory.

Returns the specified Appender for this Category, or NULL if the Appender is not attached to this Category.

Since

Returns

The Appender.

Reimplemented in log4cpp::FixedContextCategory.

Starting from this Category, search the category hierarchy for a set priority and return it. Otherwise, return the priority of the root category.

The Category class is designed so that this method executes as quickly as possible.

Reimplemented in log4cpp::FixedContextCategory.

Returns all the currently defined categories as a vector of Category pointers. Note: this function does not pass ownership of the categories in the vector to the caller, only the ownership of the vector. However vector<Category&>* is not legal C++, so we can't follow the default ownership conventions.

Unlike in log4j, the root category is included in the returned set.

Since

Instantiate a Category with name name. This method does not set priority of the category which is by default Priority::NOTSET.

Parameters

name The name of the category to retrieve.

Return the category name.

Returns

The category name.

Returns the parent category of this category, or NULL if the category is the root category.

Returns

the parent category.

Returns the parent category of this category, or NULL if the category is the root category.

Returns

the parent category.

Returns the assigned Priority, if any, for this Category.

Returns

Priority - the assigned Priority, can be Priority::NOTSET

Reimplemented in log4cpp::FixedContextCategory.

Return the root of the Category hierarchy. The root category is always instantiated and available. It's name is the empty string.

Unlike in log4j, calling Category.getInstance('') does retrieve the root category and not a category just under root named ''.

Returns

The root category

Get the priority of the root Category.

Returns

the priority of the root category

Return a CategoryStream with given Priority.

Parameters

priority The Priority of the CategoryStream.

Returns

The requested CategoryStream.

Log a message with info priority.

Parameters

stringFormat Format specifier for the string to write in the log file.
... The arguments for stringFormat

Log a message with info priority.

Parameters

message string to write in the log file

Return a CategoryStream with priority INFO.

Returns

The CategoryStream.

Return true if the Category will log messages with priority ALERT.

Returns

Whether the Category will log.

Return true if the Category will log messages with priority CRIT.

Returns

Whether the Category will log.

Return true if the Category will log messages with priority DEBUG.

Returns

Whether the Category will log.

Return true if the Category will log messages with priority EMERG.

Returns

Whether the Category will log.

Return true if the Category will log messages with priority ERROR.

Returns

Whether the Category will log.

Return true if the Category will log messages with priority FATAL. NB. priority 'fatal' is equivalent to 'emerg'.

Since

Returns

Whether the Category will log.

Return true if the Category will log messages with priority INFO.

Returns

Whether the Category will log.

Return true if the Category will log messages with priority NOTICE.

Returns

Whether the Category will log.

Returns true if the chained priority of the Category is equal to or higher than given priority.

Parameters

priority The priority to compare with.

Returns

whether logging is enable for this priority.

Return true if the Category will log messages with priority WARN.

Returns

Whether the Category will log.

Log a message with the specified priority.

Parameters

priority The priority of this log message.
stringFormat Format specifier for the string to write in the log file.
... The arguments for stringFormat

Log a message with the specified priority.

Parameters

priority The priority of this log message.
message string to write in the log file

Log a message with the specified priority.

Since

Parameters

priority The priority of this log message.
stringFormat Format specifier for the string to write in the log file.
va The arguments for stringFormat.

Log a message with notice priority.

Parameters

stringFormat Format specifier for the string to write in the log file.
... The arguments for stringFormat

Log a message with notice priority.

Parameters

message string to write in the log file

Return a CategoryStream with priority NOTICE.

Returns

The CategoryStream.

Return a CategoryStream with given Priority.

Parameters

priority The Priority of the CategoryStream.

Returns

The requested CategoryStream.

Returns true if the Category owns the first Appender in its Appender set. In that case the Category destructor will delete the Appender.

Deprecated

use ownsAppender(Appender*)

Reimplemented in log4cpp::FixedContextCategory.

Returns true if the Category owns the Appender. In that case the Category destructor will delete the Appender.

Since

Reimplemented in log4cpp::FixedContextCategory.

Removes all appenders for this Category.

Reimplemented in log4cpp::FixedContextCategory.

Removes specified appender for this Category.

Since

Set the additivity flag for this Category instance.

Reimplemented in log4cpp::FixedContextCategory.

Adds an Appender for this Category. This method does not pass ownership from the caller to the Category.

Deprecated

use addAppender(Appender&) instead.

Parameters

appender The Appender this category has to log to.

Adds an Appender to this Category. This method passes ownership from the caller to the Category.

Deprecated

use addAppender(Appender*) or removeAllAppenders() instead.

Parameters

appender The Appender this category has to log to or NULL to remove the current Appenders.

Set the priority of this Category.

Parameters

priority The priority to set. Use Priority::NOTSET to let the category use its parents priority as effective priority.

Exceptions

std::invalid_argument if the caller tries to set Priority::NOTSET on the Root Category.

Set the priority of the root Category.

Parameters

priority The new priority for the root Category

This method will remove all Appenders from Categories.XXX.

This method will remove all Appenders from Categories.XXX and delete all appenders. Releases more memory than shutdown() by deleting appenders.

Log a message with warn priority.

Parameters

stringFormat Format specifier for the string to write in the log file.
... The arguments for stringFormat

Log a message with warn priority.

Parameters

message string to write in the log file

Return a CategoryStream with priority WARN.

Returns

The CategoryStream.