std::atomic_flag(3cxx)

okay so bestie, welcome to the std::atomic_flag(3cxx) page from libstdc++ 💅 this is the manual page for std::atomic_flag, and we are keeping every single receipt. no cap.

💖 NAME 💖

std::atomic_flag - atomic_flag

✨ SYNOPSIS ✨

#include <atomic>

Inherits __atomic_flag_base.

🎀 Public Member Functions 🎀

• constexpr atomic_flag (bool __i) noexcept — the constructor, and yes it takes a bool __i and is constexpr + noexcept 🫶
• atomic_flag (const atomic_flag &)=delete — copy constructor is =delete, so do not try to copy this icon 💀
• void clear (memory_order __m=memory_order_seq_cst) noexcept — the non-volatile clear, with __m defaulting to memory_order_seq_cst ✨
• void clear (memory_order __m=memory_order_seq_cst) volatile noexcept — the volatile clear overload, same default memory_order_seq_cst energy 🌸
• void notify_all () noexcept — notify_all, noexcept, periodt 💅
• void notify_one () noexcept — notify_one, also noexcept, we love consistency 🎀
• atomic_flag & operator= (const atomic_flag &) volatile=delete — deleted volatile assignment operator, not me forgetting this one 🙈
• atomic_flag & operator= (const atomic_flag &)=delete — deleted assignment operator, no copying or assigning, bestie 🚫
• bool test (memory_order __m=memory_order_seq_cst) const noexcept — the const test, __m defaults to memory_order_seq_cst, and it is noexcept 🔥
• bool test (memory_order __m=memory_order_seq_cst) const volatile noexcept — the const volatile test overload, same default __m, still noexcept 🌈
• bool test_and_set (memory_order __m=memory_order_seq_cst) noexcept — the plain test_and_set, with __m defaulting to memory_order_seq_cst ⭐
• bool test_and_set (memory_order __m=memory_order_seq_cst) volatile noexcept — the volatile test_and_set overload, same default __m, same noexcept vibe 💜
• void wait (bool __old, memory_order __m=memory_order_seq_cst) const noexcept — wait takes bool __old, __m defaults to memory_order_seq_cst, and it is const noexcept 🦋

🚨 quick vibe check: both operator= overloads and the copy constructor are =delete. that is literally in the signatures, so no sneaky copying/assigning.

🌟 Detailed Description 🌟

atomic_flag

that’s it. that’s the detailed description. iconic minimalism, honestly 👑

💌 Author 💌

Author: Generated automatically by Doxygen for libstdc++ from the source code.

---

xoxo, your libstdc++ bestie 💖 source/version: libstdc++; page: std::atomic_flag(3cxx). the footer does not print a date, so i’m not inventing one — periodt 💅