This Category subclass replaces the NDC field in LoggingEvents with a fixed context string. More...

#include <FixedContextCategory.hh>

Inheritance diagram for FixedContextCategory:

Public Member Functions
virtual void	addAppender (Appender *appender) throw ()
	For the moment this method does nothing.
virtual void	addAppender (Appender &appender)
	For the moment this method does nothing.
virtual void	callAppenders (const LoggingEvent &event) throw ()
	Call the appenders in the hierarchy starting at `this`.
	FixedContextCategory (const std::string &name, const std::string &context="")
	Constructor.
virtual bool	getAdditivity () const throw ()
	Returns the additivity flag for this Category instance.
virtual AppenderSet	getAllAppenders () const
	Returns the set of Appenders currently attached to this Catogory.
virtual Appender *	getAppender () const
	Returns the 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 Priority::Value	getChainedPriority () const throw ()
	Starting from this Category, search the category hierarchy for a set priority and return it.
virtual std::string	getContext () const
	Return the context string used as NDC.
virtual Priority::Value	getPriority () const throw ()
	Returns the assigned Priority, if any, for this Category.
virtual bool	ownsAppender () const throw ()
	FixedContextAppenders cannot own Appenders.
virtual bool	ownsAppender (Appender *appender) const throw ()
	FixedContextAppenders cannot own Appenders.
virtual void	removeAllAppenders ()
	Removes all appenders set for this Category.
virtual void	setAdditivity (bool additivity)
	Set the additivity flag for this Category instance.
virtual void	setContext (const std::string &context)
	Set the context string used as NDC.
virtual	~FixedContextCategory ()
	Destructor for Category.
Protected Member Functions
virtual void	_logUnconditionally2 (Priority::Value priority, const std::string &message) throw ()
	Unconditionally log a message with the specified priority.
Private Attributes
std::string	_context
	The context of this FixedContextCategory.
Category &	_delegate
	The delegate category of this FixedContextCategory.

Detailed Description

This Category subclass replaces the NDC field in LoggingEvents with a fixed context string.

All handling of Appenders, etc. is delgated to the 'normal' Category with the same name. Its intended use is for object instances that serve a single client: they contruct a FixedContextCategory with the client identifier as context. Unlike with regular Category instances one has to explicitly create FixedContextCategory instances using the constructor. This also implies one has to take cake of destruction of the instance as well.

Since:: 0.2.4

Definition at line 29 of file FixedContextCategory.hh.

Constructor & Destructor Documentation

FixedContextCategory::FixedContextCategory	(	const std::string &	name,
		const std::string &	context = `""`
	)

Constructor.

Parameters:

name	the fully qualified name of this Categories delegate Category.
context	the context to fill the NDC field of LoggingEvents with.

virtual FixedContextCategory::~FixedContextCategory ( ) [virtual]

Destructor for Category.

Member Function Documentation

virtual void FixedContextCategory::_logUnconditionally2	(	Priority::Value	priority,
		const std::string &	message
	)		throw () `[protected, virtual]`

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 from Category.

virtual void FixedContextCategory::addAppender ( Appender * appender ) throw () [virtual]

For the moment this method does nothing.

Reimplemented from Category.

virtual void FixedContextCategory::addAppender ( Appender & appender ) [virtual]

For the moment this method does nothing.

Reimplemented from Category.

virtual void FixedContextCategory::callAppenders ( const LoggingEvent & event ) throw () [virtual]

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 LoggingEvent to log.

Reimplemented from Category.

virtual bool FixedContextCategory::getAdditivity ( ) const throw () [virtual]

Returns the additivity flag for this Category instance.

Reimplemented from Category.

virtual AppenderSet FixedContextCategory::getAllAppenders ( ) const [virtual]

Returns the set of Appenders currently attached to this Catogory.

Since:: 0.3.1

Returns:: The set of attached Appenders.

Reimplemented from Category.

virtual Appender* FixedContextCategory::getAppender ( ) const [virtual]

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

Returns:: The Appender.

Reimplemented from Category.

virtual Appender* FixedContextCategory::getAppender ( const std::string & name ) const [virtual]

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

Since:: 0.2.7

Returns:: The Appender.

Reimplemented from Category.

virtual Priority::Value FixedContextCategory::getChainedPriority ( ) const throw () [virtual]

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 from Category.

virtual std::string FixedContextCategory::getContext ( ) const [virtual]

Return the context string used as NDC.

Returns:: the context string.

virtual Priority::Value FixedContextCategory::getPriority ( ) const throw () [virtual]

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

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

Reimplemented from Category.

virtual bool FixedContextCategory::ownsAppender ( ) const throw () [virtual]

FixedContextAppenders cannot own Appenders.

Returns:: false

Reimplemented from Category.

virtual bool FixedContextCategory::ownsAppender ( Appender * appender ) const throw () [virtual]

FixedContextAppenders cannot own Appenders.

Returns:: false

Reimplemented from Category.

virtual void FixedContextCategory::removeAllAppenders ( ) [virtual]

Removes all appenders set for this Category.

Currently a Category can have only one appender, but this may change in the future.

Reimplemented from Category.

virtual void FixedContextCategory::setAdditivity ( bool additivity ) [virtual]

Set the additivity flag for this Category instance.

Reimplemented from Category.

virtual void FixedContextCategory::setContext ( const std::string & context ) [virtual]

Set the context string used as NDC.

Parameters:

context the context string

Member Data Documentation

std::string FixedContextCategory::_context [private]

The context of this FixedContextCategory.

Definition at line 169 of file FixedContextCategory.hh.

Category& FixedContextCategory::_delegate [private]

The delegate category of this FixedContextCategory.

Definition at line 166 of file FixedContextCategory.hh.

The documentation for this class was generated from the following file:

FixedContextCategory.hh

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation