log4cpp::H...Maintainer(3)

💅 log4cpp::HierarchyMaintainer(3) — Library Functions Manual ✨

okay so bestie, welcome to the log4cpp::HierarchyMaintainer page 💖 this one lives in the Library Functions Manual section, and it's fully a behind-the-scenes situation — like the stage crew of your logging setup, iykyk 🎭

---

🌸 NAME 🌸

log4cpp::HierarchyMaintainer — so like, HierarchyMaintainer is an internal log4cpp class 🫶 that's literally the whole vibe. It's not for you to touch, babe, it's the machinery.

---

✨ SYNOPSIS ✨

#include <HierarchyMaintainer.hh>

🎀 Public Types 🎀

• CategoryMap — a typedef for std::map< std::string, Category * > 💫
• shutdown_fun_ptr — a typedef for void(* shutdown_fun_ptr) (), aka a lil function pointer that takes nothing and returns nothing 🧚

🦋 Public Member Functions 🦋

• HierarchyMaintainer () — the constructor, we love a fresh start 🌱
• virtual ~HierarchyMaintainer () — the virtual destructor, say bye cleanly 👋
• virtual Category * getExistingInstance (const std::string &name) — grab an instance if it already exists 👀
• virtual Category & getInstance (const std::string &name) — get your instance, by reference, bestie 🔥
• virtual std::vector< Category * > * getCurrentCategories () const — a pointer to a vector of all the current Category*s, and it's const so it behaves 😌
• virtual void shutdown () — shut it all down 🛑
• void register_shutdown_handler (shutdown_fun_ptr handler) — hook up your shutdown handler 🪝
• virtual void deleteAllCategories () — yeet (delete) all the categories 💀

🌈 Static Public Member Functions 🌈

• static HierarchyMaintainer & getDefaultMaintainer () — the default maintainer, by reference, and it's static so there's one of it ⭐

💜 Protected Member Functions 💜

• virtual Category * _getExistingInstance (const std::string &name) — the underscored version, protected 👑
• virtual Category & _getInstance (const std::string &name) — again, underscored, protected, by reference 💅

🍓 Protected Attributes 🍓

• CategoryMap _categoryMap — the map holding your categories 🗺️
• threading::Mutex _categoryMutex — the mutex keeping it thread-safe 🔒

⭐ Friends ⭐

• class Log4cppCleanup — bestie privileges granted 🤝

---

🌼 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 🚫 — like, it's giving backstage pass only, no cap.

so fr fr: if you're an app developer, this is not your main character energy. leave it to log4cpp 💅

---

🧚 Member Typedef Documentation 🧚

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

that's the map type, exactly std::map<std::string, Category*> ⭐

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

that's the function pointer type: void(* ...) () 🎀

---

🌸 Constructor & Destructor Documentation 🌸

log4cpp::HierarchyMaintainer::HierarchyMaintainer ()

the plain ol' constructor, no args, living its best life ✨

log4cpp::HierarchyMaintainer::~HierarchyMaintainer () [virtual]

the destructor, and yes it's [virtual] so it cleans up properly 👑

---

🦋 Member Function Documentation 🦋

Category * log4cpp::HierarchyMaintainer::_getExistingInstance (const std::string & name) [protected], [virtual]

protected and virtual, underscored — the internal one 🔐

Category & log4cpp::HierarchyMaintainer::_getInstance (const std::string & name) [protected], [virtual]

same deal: [protected], [virtual], returns a Category & 💫

void log4cpp::HierarchyMaintainer::deleteAllCategories () [virtual]

[virtual], takes nothing, returns void, deletes all the categories 💀

std::vector< Category * > * log4cpp::HierarchyMaintainer::getCurrentCategories () const [virtual]

[virtual] and const, gives you back a std::vector< Category * > * 📋

HierarchyMaintainer & log4cpp::HierarchyMaintainer::getDefaultMaintainer () [static]

[static] — returns a HierarchyMaintainer & 🏆

Category * log4cpp::HierarchyMaintainer::getExistingInstance (const std::string & name) [virtual]

[virtual], public version, returns Category * 👀

Category & log4cpp::HierarchyMaintainer::getInstance (const std::string & name) [virtual]

[virtual], public version, returns Category & 🔥

void log4cpp::HierarchyMaintainer::register_shutdown_handler (shutdown_fun_ptr handler)

takes a shutdown_fun_ptr handler, returns void 🪝

void log4cpp::HierarchyMaintainer::shutdown () [virtual]

[virtual], returns void, that's the whole signature 🛑

---

🎀 Friends And Related Symbol Documentation 🎀

friend class Log4cppCleanup [friend]

yup, Log4cppCleanup is a friend, [friend], iconic 🤝

---

💜 Member Data Documentation 💜

CategoryMap log4cpp::HierarchyMaintainer::_categoryMap [protected]

the CategoryMap, tagged [protected] 🗺️

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

the threading::Mutex, and bestie it's [mutable] and [protected] — both tags, don't lose 'em 🔒

---

👑 Author 👑

Generated automatically by Doxygen for log4cpp from the source code 🤖💖 (so like, no human wrote this, it's the robot's fault, periodt)

---

k bye bestie, that's the whole page 🫶 — this was log4cpp, Version 1.1, and the page is log4cpp::H...Maintainer(3). slay, go read the actual Category docs now ✨💅