log4shib::threading(3)

📦 version 2.0.1, in opensuse-leap 16.0

💖 log4shib::threading(3) — welcome to the threading page, bestie 💖

Okay so this is log4shib::threading(3), straight out of the Library Functions Manual for log4shib — section 3, library functions, periodt. It's giving classes, typedefs, and one function that tells you which thread you're in. Let's get into it, no cap. 🧵✨

✨ NAME ✨

log4shib::threading — literally the name, that's the whole vibe. 🎀

🌸 SYNOPSIS 🌸

Here's the whole structure: classes, typedefs, functions. Organized, iconic, lowkey essential.

👑 Classes

  • class MSMutex — a simple object wrapper around CreateMutex() and DeleteMutex() 🫶
  • class MSScopedLock — a simple object wrapper around WaitForSingleObject() and ReleaseMutex() 😌
  • class Mutex — it's a class called Mutex, bestie. That's the info.
  • class ScopedLock — definition of ScopedLock; (yes, semicolon included, don't ask 💀)
  • class ThreadLocalDataHolder — this class holds Thread local data of type T, i.e. 💾

🦋 Typedefs

  • typedef boost::mutex Mutex — dummy type 'int' for Mutex. 💀
  • typedef boost::mutex::scoped_lock ScopedLock — dummy type 'int' defintion of ScopedLock;. (the typo is canon, not me 🙈)

⭐ Functions

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

🧚 Typedef Documentation 🧚

Okay now the spicy details.

typedef omni_mutex log4shib::threading::Mutex

Dummy type 'int' for Mutex. A simple, non recursive Mutex. 🚫🔁

Yes, this adds a bit of overhead in the for of extra memory, but unfortunately 'void' is illegal. 💀 (I know, I know — "for of" is exactly what the page says, don't come for me.)

Equivalent to Boost.Threads boost::mutex. ✨

typedef omni_mutex_lock log4shib::threading::ScopedLock

Dummy type 'int' defintion of ScopedLock;. A simple "resource acquisition is initialization" idiom type lock for Mutex. 🎀

Equivalent to Boost.Threads boost::scoped_lock. 💜

🔥 Function Documentation 🔥

std::string log4shib::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. 👑

🌈 Author 🌈

Generated automatically by Doxygen for log4shib from the source code. 🤖💖

And that's the page, bestie — log4shib Version 2.0.1, log4shib::threading(3) signing off with all the threading lore intact. Bye and slay! 💅🫶🎀

📦 where this page comes from