log4cpp::HierarchyMaintainer Class Reference

#include <HierarchyMaintainer.hh>

List of all members.

Public Types
typedef std::map< std::string, Category * >	CategoryMap
typedef Category *(*	creator_function_t )(const std::string &name, log4cpp::Category *parent, log4cpp::Priority::Value priority)
typedef void(*	shutdown_fun_ptr )()
Public Member Functions
virtual void	deleteAllCategories ()
virtual std::vector< Category * > *	getCurrentCategories () const
virtual Category *	getExistingInstance (const std::string &name)
virtual Category &	getInstance (const std::string &name)
	HierarchyMaintainer ()
void	register_shutdown_handler (shutdown_fun_ptr handler)
virtual void	shutdown ()
virtual	~HierarchyMaintainer ()
Static Public Member Functions
static HierarchyMaintainer &	getDefaultMaintainer ()
static void	set_category_factory (creator_function_t creator_function)
Protected Member Functions
virtual Category *	_getExistingInstance (const std::string &name)
virtual Category &	_getInstance (const std::string &name)
Protected Attributes
CategoryMap	_categoryMap
threading::Mutex	_categoryMutex
Private Types
typedef std::vector < shutdown_fun_ptr >	handlers_t
Static Private Member Functions
static Category *	make_category (const std::string &name, log4cpp::Category *parent, log4cpp::Priority::Value priority)
Private Attributes
handlers_t	handlers_
Static Private Attributes
static creator_function_t	_creator_function = 0
static HierarchyMaintainer *	_defaultMaintainer
Friends
class	Log4cppCleanup

---

Detailed Description

HierarchyMaintainer is an internal log4cpp class. It is responsible for maintaining the hierarchy of Categories. Applications should not have to use this class directly.

Definition at line 27 of file HierarchyMaintainer.hh.

---

Member Typedef Documentation

typedef std::map<std::string, Category*> log4cpp::HierarchyMaintainer::CategoryMap

Definition at line 31 of file HierarchyMaintainer.hh.

typedef Category*(* log4cpp::HierarchyMaintainer::creator_function_t)(const std::string &name, log4cpp::Category *parent, log4cpp::Priority::Value priority)

Definition at line 45 of file HierarchyMaintainer.hh.

typedef std::vector<shutdown_fun_ptr> log4cpp::HierarchyMaintainer::handlers_t [private]

Definition at line 58 of file HierarchyMaintainer.hh.

typedef void(* log4cpp::HierarchyMaintainer::shutdown_fun_ptr)()

Definition at line 32 of file HierarchyMaintainer.hh.

---

Constructor & Destructor Documentation

log4cpp::HierarchyMaintainer::HierarchyMaintainer

(

)

Definition at line 34 of file HierarchyMaintainer.cpp.

log4cpp::HierarchyMaintainer::~HierarchyMaintainer

(

)

[virtual]

Definition at line 37 of file HierarchyMaintainer.cpp.

---

Member Function Documentation

Category * log4cpp::HierarchyMaintainer::_getExistingInstance

(

const std::string &

name

)

[protected, virtual]

Definition at line 47 of file HierarchyMaintainer.cpp.

Category & log4cpp::HierarchyMaintainer::_getInstance

(

const std::string &

name

)

[protected, virtual]

Definition at line 64 of file HierarchyMaintainer.cpp.

void log4cpp::HierarchyMaintainer::deleteAllCategories

(

)

[virtual]

Definition at line 124 of file HierarchyMaintainer.cpp.

std::vector< Category * > * log4cpp::HierarchyMaintainer::getCurrentCategories

(

)

const [virtual]

Definition at line 87 of file HierarchyMaintainer.cpp.

HierarchyMaintainer & log4cpp::HierarchyMaintainer::getDefaultMaintainer

(

)

[static]

Definition at line 28 of file HierarchyMaintainer.cpp.

Category * log4cpp::HierarchyMaintainer::getExistingInstance

(

const std::string &

name

)

[virtual]

Definition at line 42 of file HierarchyMaintainer.cpp.

Category & log4cpp::HierarchyMaintainer::getInstance

(

const std::string &

name

)

[virtual]

Definition at line 58 of file HierarchyMaintainer.cpp.

Category * log4cpp::HierarchyMaintainer::make_category	(	const std::string &	name,
		log4cpp::Category *	parent,
		log4cpp::Priority::Value	priority
	)		[static, private]

Definition at line 140 of file HierarchyMaintainer.cpp.

void log4cpp::HierarchyMaintainer::register_shutdown_handler

(

shutdown_fun_ptr

handler

)

Definition at line 119 of file HierarchyMaintainer.cpp.

void log4cpp::HierarchyMaintainer::set_category_factory

(

creator_function_t

creator_function

)

[static]

Definition at line 134 of file HierarchyMaintainer.cpp.

void log4cpp::HierarchyMaintainer::shutdown

(

)

[virtual]

Definition at line 100 of file HierarchyMaintainer.cpp.

---

Friends And Related Function Documentation

friend class Log4cppCleanup [friend]

Definition at line 28 of file HierarchyMaintainer.hh.

---

Member Data Documentation

CategoryMap log4cpp::HierarchyMaintainer::_categoryMap [protected]

Definition at line 54 of file HierarchyMaintainer.hh.

threading::Mutex log4cpp::HierarchyMaintainer::_categoryMutex [mutable, protected]

Definition at line 55 of file HierarchyMaintainer.hh.

HierarchyMaintainer::creator_function_t log4cpp::HierarchyMaintainer::_creator_function = 0 [static, private]

Definition at line 66 of file HierarchyMaintainer.hh.

HierarchyMaintainer* log4cpp::HierarchyMaintainer::_defaultMaintainer [static, private]

Definition at line 60 of file HierarchyMaintainer.hh.

handlers_t log4cpp::HierarchyMaintainer::handlers_ [private]

Definition at line 61 of file HierarchyMaintainer.hh.

---

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

• HierarchyMaintainer.hh
• HierarchyMaintainer.cpp