summaryrefslogtreecommitdiff
path: root/devdocs/c/atomic%2Fatomic_flag.html
diff options
context:
space:
mode:
authorCraig Jennings <c@cjennings.net>2024-04-07 13:41:34 -0500
committerCraig Jennings <c@cjennings.net>2024-04-07 13:41:34 -0500
commit754bbf7a25a8dda49b5d08ef0d0443bbf5af0e36 (patch)
treef1190704f78f04a2b0b4c977d20fe96a828377f1 /devdocs/c/atomic%2Fatomic_flag.html
new repository
Diffstat (limited to 'devdocs/c/atomic%2Fatomic_flag.html')
-rw-r--r--devdocs/c/atomic%2Fatomic_flag.html26
1 files changed, 26 insertions, 0 deletions
diff --git a/devdocs/c/atomic%2Fatomic_flag.html b/devdocs/c/atomic%2Fatomic_flag.html
new file mode 100644
index 00000000..9ce4958c
--- /dev/null
+++ b/devdocs/c/atomic%2Fatomic_flag.html
@@ -0,0 +1,26 @@
+ <h1 id="firstHeading" class="firstHeading">atomic_flag</h1> <table class="t-dcl-begin"> <tr class="t-dsc-header"> <th> Defined in header <code>&lt;stdatomic.h&gt;</code> </th> <th> </th> <th> </th> </tr> <tr class="t-dcl t-since-c11"> <td> <pre data-language="c">struct atomic_flag;</pre>
+</td> <td class="t-dcl-nopad"> </td> <td> <span class="t-mark-rev t-since-c11">(since C11)</span> </td> </tr> </table> <p><code>atomic_flag</code> is an atomic boolean type. Unlike other atomic types, it is guaranteed to be lock-free. Unlike <a href="../thread#Atomic_operations" title="c/thread"><code>atomic_bool</code></a>, <code>atomic_flag</code> does not provide load or store operations.</p>
+<h3 id="References"> References</h3> <ul>
+<li> C17 standard (ISO/IEC 9899:2018): </li>
+<ul>
+<li> 7.17.1/4 atomic_flag (p: 200) </li>
+<li> 7.17.8 Atomic flag type and operations (p: 208-209) </li>
+</ul>
+<li> C11 standard (ISO/IEC 9899:2011): </li>
+<ul>
+<li> 7.17.1/4 atomic_flag (p: 273) </li>
+<li> 7.17.8 Atomic flag type and operations (p: 285-286) </li>
+</ul>
+</ul> <h3 id="See_also"> See also</h3> <table class="t-dsc-begin"> <tr class="t-dsc"> <td> <div><a href="atomic_flag_init" title="c/atomic/ATOMIC FLAG INIT"> <span class="t-lines"><span>ATOMIC_FLAG_INIT</span></span></a></div>
+<div><span class="t-lines"><span><span class="t-mark-rev t-since-c11">(C11)</span></span></span></div> </td> <td> initializes a new <code>atomic_flag</code> <br> <span class="t-mark">(macro constant)</span> </td>
+</tr> <tr class="t-dsc"> <td> <div><a href="atomic_flag_test_and_set" title="c/atomic/atomic flag test and set"> <span class="t-lines"><span>atomic_flag_test_and_set</span><span>atomic_flag_test_and_set_explicit</span></span></a></div>
+<div><span class="t-lines"><span><span class="t-mark-rev t-since-c11">(C11)</span></span></span></div> </td> <td> sets an atomic_flag to true and returns the old value <br> <span class="t-mark">(function)</span> </td>
+</tr> <tr class="t-dsc"> <td> <div><a href="atomic_flag_clear" title="c/atomic/atomic flag clear"> <span class="t-lines"><span>atomic_flag_clear</span><span>atomic_flag_clear_explicit</span></span></a></div>
+<div><span class="t-lines"><span><span class="t-mark-rev t-since-c11">(C11)</span></span></span></div> </td> <td> sets an atomic_flag to false <br> <span class="t-mark">(function)</span> </td>
+</tr> <tr class="t-dsc"> <td colspan="2"> <span><a href="https://en.cppreference.com/w/cpp/atomic/atomic_flag" title="cpp/atomic/atomic flag">C++ documentation</a></span> for <code>atomic_flag</code> </td>
+</tr> </table> <div class="_attribution">
+ <p class="_attribution-p">
+ &copy; cppreference.com<br>Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.<br>
+ <a href="https://en.cppreference.com/w/c/atomic/atomic_flag" class="_attribution-link">https://en.cppreference.com/w/c/atomic/atomic_flag</a>
+ </p>
+</div>