SbMutex(3)

💅 SbMutex(3) 💅

okay so bestie, this one is from the Library Functions Manual, and it's literally all about a basic class for managing a mutex. SbMutex is the main character here. no cap. 🫶

---

✨ NAME ✨

SbMutex — a basic class for managing a mutex. periodt. 💖

🦋 SYNOPSIS 🦋

#include <Inventor/threads/SbMutex.h>

🌸 Public Member Functions 🌸

• SbMutex (void)
• ~SbMutex (void)
• int lock (void)
• SbBool tryLock (void)
• int unlock (void)

🎀 Friends 🎀

• class SbCondVar

💖 Detailed Description 💖

A basic class for managing a mutex. that's the whole vibe, but keep reading because there's more.

This class provides a portable framework around the mutex interface of the underlying native thread-handling toolkit. so like, it's giving "same energy everywhere" for mutex stuff. ✨

🧚 Constructor & Destructor Documentation 🧚

SbMutex::SbMutex (void ) [inline]

Constructor. it makes the thing. 💅

SbMutex::~SbMutex (void ) [inline]

Destructor. it cleans up the thing. 🌈

👑 Member Function Documentation 👑

int SbMutex::lock (void ) [inline]

This method locks the mutex. 0 is returned on success. slay.

If the mutex was previously unlocked, the thread will lock the mutex and continue running. If the mutex was already locked when this call is made, the thread will be suspended until the other thread holding the mutex releases it.

This is a blocking operation. so yeah, your thread might be waiting in the group chat until the other thread is done. no cutting the line, bestie. 😭

Referenced by SbThreadAutoLock::SbThreadAutoLock().

SbBool SbMutex::tryLock (void ) [inline]

This method tries to lock the mutex, and returns whether it was locked or not. This is a non-blocking operation. it's giving "just checking, no pressure" energy. ✨

int SbMutex::unlock (void ) [inline]

This method unlocks the mutex. release it, let it breathe, set it free. 🦋

Referenced by SbThreadAutoLock::~SbThreadAutoLock().

🎀 Author 🎀

Generated automatically by Doxygen for Coin from the source code. so not a human author, just Doxygen doing its lil thing. 🤖💖

---

Signing off: this page is from Coin, Version 2.5.0. no date listed, but the version is right there, bestie. catch you later! 💅✨🫶