log4cpp::threading(3)

🌸 NAME 🌸

Okay bestie, welcome to log4cpp::threading(3) — from the Library Functions Manual, no less. This is the threading little corner of log4cpp, and the docs are here to hand you the classes, typedefs, and the one function in this page. Lowkey iconic, highkey useful. 💅

---

✨ SYNOPSIS ✨

🎀 Classes 🎀

• class MSMutex — a simple object wrapper around CreateMutex() and DeleteMutex().
• class MSScopedLock — a simple object wrapper around WaitForSingleObject() and ReleaseMutex().
• class Mutex — just the class name, no extra description attached. Main character energy with no caption.
• class ScopedLock — the description is literally definition of ScopedLock; — semicolon included, because we keep the receipts.
• class ThreadLocalDataHolder — this class holds Thread local data of type T, i.e. — and yes, the original line literally ends on that i.e. 🫶

🧵 Typedefs 🧵

• typedef boost::mutex Mutex — the docs call this Dummy type 'int' for Mutex. — no cap, that's the actual wording.
• typedef boost::mutex::scoped_lock ScopedLock — and this one is called Dummy type 'int' defintion of ScopedLock;. — typo defintion is preserved, because we do not edit the source's little quirks. 💀

🔥 Functions 🔥

• static std::string getThreadId () — return an identifier for the current thread.

---

📚 Typedef Documentation 📚

typedef omni_mutex log4cpp::threading::Mutex

So this documented typedef is typedef omni_mutex log4cpp::threading::Mutex. The description opens with Dummy type 'int' for Mutex. — yes, really. It's a simple, non recursive Mutex.

The docs also say, quote-for-quote: Yes, this adds a bit of overhead in the for of extra memory, but unfortunately 'void' is illegal. That for is their spelling, not mine — I'm just holding the receipt. 🧾

Equivalent to Boost.Threads boost::mutex.

typedef omni_mutex_lock log4cpp::threading::ScopedLock

This one is typedef omni_mutex_lock log4cpp::threading::ScopedLock. Its description starts with Dummy type 'int' defintion of ScopedLock;. — again, defintion stays exactly as the page gives it. It's a simple "resource acquisition is initialization" idiom type lock for Mutex.

Equivalent to Boost.Threads boost::scoped_lock.

---

🧵 Function Documentation 🧵

std::string log4cpp::threading::getThreadId () [static]

Return an identifier for the current thread. returns the thread ID.

What these identifiers look like is completely up to the underlying thread library.

What these identifiers look like is completely up to the underlying thread library. OmniThreads returns the POSIX thread Id.

Bestie, yes — the page says that sentence twice. I'm not summarising it away, because every detail stays. Periodt. ✨

---

👑 Author 👑

Generated automatically by Doxygen for log4cpp from the source code.

---

Bye bestie 💖 — this footer's giving log4cpp, Version 1.1, and the manual page tag log4cpp::threading(3); that's the source/version and page signature at the end, and there's no extra date printed in the footer, so I'm not inventing one. Slay. 🎀