include/Zy...nization.h(3)

📦
version 1.5.2 · 2 versions
, in ubuntu resolute, ubuntu stonking

💅 include/Zy...nization.h(3)

okay bestie, welcome to the Library Functions Manual for include/Zycore/API/Synchronization.h ✨ this is the header that handles critical sections for Zycore, and honestly? she's small but she's mighty. no cap.

🌸 NAME 🌸

include/Zycore/API/Synchronization.h

like... that's literally her. that's the name. iconic.

✨ SYNOPSIS ✨

#include <Zycore/Defines.h>
#include <Zycore/Status.h>

🎀 Functions 🎀

  • ZYCORE_EXPORT ZyanStatus ZyanCriticalSectionInitialize (ZyanCriticalSection *critical_section)
  • ZYCORE_EXPORT ZyanStatus ZyanCriticalSectionEnter (ZyanCriticalSection *critical_section)
  • ZYCORE_EXPORT ZyanBool ZyanCriticalSectionTryEnter (ZyanCriticalSection *critical_section)
  • ZYCORE_EXPORT ZyanStatus ZyanCriticalSectionLeave (ZyanCriticalSection *critical_section)
  • ZYCORE_EXPORT ZyanStatus ZyanCriticalSectionDelete (ZyanCriticalSection *critical_section)

🦋 Function Documentation 🦋

ZYCORE_EXPORT ZyanStatus ZyanCriticalSectionDelete (ZyanCriticalSection *critical_section)

Deletes a critical section. rip to her, she had a good run 🪦💀

Parameters

  • critical_section — A pointer to the ZyanCriticalSection struct.

ZYCORE_EXPORT ZyanStatus ZyanCriticalSectionEnter (ZyanCriticalSection *critical_section)

Enters a critical section. you're going in, bestie 🚪✨

Parameters

  • critical_section — A pointer to the ZyanCriticalSection struct.

ZYCORE_EXPORT ZyanStatus ZyanCriticalSectionInitialize (ZyanCriticalSection *critical_section)

Initializes a critical section. gotta set her up before she can slay 💅

Parameters

  • critical_section — A pointer to the ZyanCriticalSection struct.

ZYCORE_EXPORT ZyanStatus ZyanCriticalSectionLeave (ZyanCriticalSection *critical_section)

Leaves a critical section. ok bye, see you never (until next time) 👋🌸

Parameters

  • critical_section — A pointer to the ZyanCriticalSection struct.

ZYCORE_EXPORT ZyanBool ZyanCriticalSectionTryEnter (ZyanCriticalSection *critical_section)

Tries to enter a critical section. she's giving "let me in" energy, and honestly? sometimes the answer is just no 🙈

Parameters

  • critical_section — A pointer to the ZyanCriticalSection struct.

Returns

Returns ZYAN_TRUE if the critical section was successfully entered, or ZYAN_FALSE, if not. so basically a vibe check that returns a bool 🫶

👑 Author 👑

Generated automatically by Doxygen for Zycore from the source code. not a human, not a bestie, just a robot doing her little robot thing, and we respect her for it 🤖💜

and that's the whole page, fr fr — this was Zycore, Version 1.5.2.0, dated include/Zy...nization.h(3). periodt. 💖

📦 where this page comes from