diff options
| author | Craig Jennings <c@cjennings.net> | 2024-04-07 13:41:34 -0500 |
|---|---|---|
| committer | Craig Jennings <c@cjennings.net> | 2024-04-07 13:41:34 -0500 |
| commit | 754bbf7a25a8dda49b5d08ef0d0443bbf5af0e36 (patch) | |
| tree | f1190704f78f04a2b0b4c977d20fe96a828377f1 /devdocs/c/thread%2Fcnd_timedwait.html | |
new repository
Diffstat (limited to 'devdocs/c/thread%2Fcnd_timedwait.html')
| -rw-r--r-- | devdocs/c/thread%2Fcnd_timedwait.html | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/devdocs/c/thread%2Fcnd_timedwait.html b/devdocs/c/thread%2Fcnd_timedwait.html new file mode 100644 index 00000000..96b61762 --- /dev/null +++ b/devdocs/c/thread%2Fcnd_timedwait.html @@ -0,0 +1,24 @@ + <h1 id="firstHeading" class="firstHeading">cnd_timedwait</h1> <table class="t-dcl-begin"> <tr class="t-dsc-header"> <th> Defined in header <code><threads.h></code> </th> <th> </th> <th> </th> </tr> <tr class="t-dcl t-since-c11"> <td> <pre data-language="c">int cnd_timedwait( cnd_t* restrict cond, mtx_t* restrict mutex, + const struct timespec* restrict time_point );</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 the <code>TIME_UTC</code> based time point pointed to by <code>time_point</code> has been reached, 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> <tr class="t-par"> <td> time_point </td> <td> - </td> <td> pointer to an object specifying timeout time to wait until </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>thrd_timedout</code> if the timeout time has been reached before the mutex is locked, or <code><a href="thrd_errors" title="c/thread/thrd errors">thrd_error</a></code> if an error occurred.</p> +<h3 id="References"> References</h3> <ul> +<li> C17 standard (ISO/IEC 9899:2018): </li> +<ul><li> 7.26.3.5 The cnd_timedwait function (p: 276-277) </li></ul> +<li> C11 standard (ISO/IEC 9899:2011): </li> +<ul><li> 7.26.3.5 The cnd_timedwait function (p: 379-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_wait" title="c/thread/cnd wait"> <span class="t-lines"><span>cnd_wait</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 <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_until" title="cpp/thread/condition variable/wait until">C++ documentation</a></span> for <code>condition_variable::wait_until</code> </td> +</tr> <tr class="t-dsc"> <td colspan="2"> <span><a href="https://en.cppreference.com/w/cpp/thread/condition_variable_any/wait_until" title="cpp/thread/condition variable any/wait until">C++ documentation</a></span> for <code>condition_variable_any::wait_until</code> </td> +</tr> </table> <div class="_attribution"> + <p class="_attribution-p"> + © 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_timedwait" class="_attribution-link">https://en.cppreference.com/w/c/thread/cnd_timedwait</a> + </p> +</div> |
