devdocs/c/thread%2Fcnd_wait.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

    <h1 id="firstHeading" class="firstHeading">cnd_wait</h1>            <table class="t-dcl-begin"> <tr class="t-dsc-header"> <th> Defined in header <code>&lt;threads.h&gt;</code> </th> <th> </th> <th> </th> </tr> <tr class="t-dcl t-since-c11"> <td> <pre data-language="c">int cnd_wait( cnd_t* cond, mtx_t* mutex );</pre>
</td> <td class="t-dcl-nopad"> </td> <td> <span class="t-mark-rev t-since-c11">(since C11)</span> </td> </tr>  </table> <p>Atomically unlocks the mutex pointed to by <code>mutex</code> and blocks on the condition variable pointed to by <code>cond</code> until the thread is signalled by <code><a href="cnd_signal" title="c/thread/cnd signal">cnd_signal</a></code> or <code><a href="cnd_broadcast" title="c/thread/cnd broadcast">cnd_broadcast</a></code>, or until a spurious wake-up occurs. The mutex is locked again before the function returns.</p>
<p>The behavior is undefined if the mutex is not already locked by the calling thread.</p>
<h3 id="Parameters"> Parameters</h3> <table class="t-par-begin"> <tr class="t-par"> <td> cond </td> <td> - </td> <td> pointer to the condition variable to block on </td>
</tr> <tr class="t-par"> <td> mutex </td> <td> - </td> <td> pointer to the mutex to unlock for the duration of the block </td>
</tr>
</table> <h3 id="Return_value"> Return value</h3> <p><code><a href="thrd_errors" title="c/thread/thrd errors">thrd_success</a></code> if successful, <code><a href="thrd_errors" title="c/thread/thrd errors">thrd_error</a></code> otherwise.</p>
<h3 id="References"> References</h3>  <ul>
<li> C17 standard (ISO/IEC 9899:2018): </li>
<ul><li> 7.26.3.6 The cnd_wait function (p: 277) </li></ul>
<li> C11 standard (ISO/IEC 9899:2011): </li>
<ul><li> 7.26.3.6 The cnd_wait function (p: 380) </li></ul>
</ul>       <h3 id="See_also"> See also</h3> <table class="t-dsc-begin"> <tr class="t-dsc"> <td> <div><a href="cnd_timedwait" title="c/thread/cnd timedwait"> <span class="t-lines"><span>cnd_timedwait</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> blocks on a condition variable, with a timeout <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/thread/condition_variable/wait" title="cpp/thread/condition variable/wait">C++ documentation</a></span> for <code>condition_variable::wait</code> </td>
</tr> <tr class="t-dsc"> <td colspan="2"> <span><a href="https://en.cppreference.com/w/cpp/thread/condition_variable_any/wait" title="cpp/thread/condition variable any/wait">C++ documentation</a></span> for <code>condition_variable_any::wait</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/thread/cnd_wait" class="_attribution-link">https://en.cppreference.com/w/c/thread/cnd_wait</a>
  </p>
</div>