SbThreadAutoLock(3)

💖 NAME 💖

SbThreadAutoLock — the simple convenience class for locking access to a function. that's it, that's the whole vibe ✨

---

🌸 SYNOPSIS 🌸

#include <Inventor/threads/SbThreadAutoLock.h>

🎀 Public Member Functions

• SbThreadAutoLock (SbMutex *mutexptr)
• SbThreadAutoLock (SbThreadMutex *mutexptr)
• ~SbThreadAutoLock ()

🦋 Protected Attributes

• SbMutex * mutex
• SbThreadMutex * recmutex

---

✨ Detailed Description ✨

okay bestie, so. SbThreadAutoLock is the simple convenience class for locking access to a function. 🫶

what it does is give you a simple convenience mechanism for automatically locking access to a function that is not re-entrant. no cap.

Usage example, and yes you're gonna want to screenshot this:

void
myfunction(void)
{
  SbThreadAutoLock lock(aMutexPtr);

  // [other code]
}

the way this works is: in the class constructor, SbMutex::lock() gets called on the mutex. and then when the function exits — this is the convenience part, this is the whole moment, the main character energy — the destructor gets automatically invoked, and it calls SbMutex::unlock() on that same mutex. it's giving RAII. it's giving scoped lock. it's giving iconic. 💅

---

👑 Constructor & Destructor Documentation 👑

💜 SbThreadAutoLock::SbThreadAutoLock (SbMutex * mutex) [inline]

the constructor calls SbMutex::lock() on mutex. that's it. that's the job. slay.

💜 SbThreadAutoLock::SbThreadAutoLock (SbThreadMutex * mutex) [inline]

the constructor calls SbThreadMutex::lock() on mutex. same energy, different mutex type. 💫

💜 SbThreadAutoLock::~SbThreadAutoLock () [inline]

the destructor calls unlock() on the mutex that got passed in as a parameter to the constructor. she cleans up after herself. we love a queen who does her own dishes 🍓

---

🌈 Member Data Documentation 🌈

⭐ SbThreadMutex* SbThreadAutoLock::recmutex [protected]

heads up bestie: this API member is considered internal to the library, as it is not likely to be of interest to the application programmer. so like… look away 🙈

---

🌟 Author 🌟

Generated automatically by Doxygen for Coin from the source code. no human wrote this one, it manifested itself fr fr 😭

---

and that's the whole page, bestie!! this was SbThreadAutoLock(3) from the Coin Library Functions Manual, Version 3.1.3 — ty for reading, ily, go lock something safely 💖✨🎀🦋