path: root/devdocs/c/thread%2Fmtx_timedlock.html

    <h1 id="firstHeading" class="firstHeading">mtx_timedlock</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 mtx_timedlock( 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>Blocks the current thread until the mutex pointed to by <code>mutex</code> is locked or until the <code>TIME_UTC</code> based absolute calendar time point pointed to by <code>time_point</code> has been reached.</p>
<p>Since this function takes an absolute time, if a duration is required, the calendar time point must be calculated manually.</p>
<p>The behavior is undefined if the current thread has already locked the mutex and the mutex is not recursive.</p>
<p>The behavior is undefined if the mutex does not support timeout.</p>
<p>Prior calls to <code><a href="mtx_unlock" title="c/thread/mtx unlock">mtx_unlock</a></code> on the same mutex <i>synchronize-with</i> this operation (if this operation succeeds), and all lock/unlock operations on any given mutex form a single total order (similar to the modification order of an atomic)</p>
<h3 id="Parameters"> Parameters</h3> <table class="t-par-begin"> <tr class="t-par"> <td> mutex </td> <td> - </td> <td> pointer to the mutex to lock </td>
</tr> <tr class="t-par"> <td> time_point </td> <td> - </td> <td> pointer to the absolute calendar time until which to wait for the timeout </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, <code><a href="thrd_errors" title="c/thread/thrd errors">thrd_error</a></code> if an error occurs.</p>
<h3 id="References"> References</h3>  <ul>
<li> C17 standard (ISO/IEC 9899:2018): </li>
<ul><li> 7.26.4.4 The mtx_timedlock function (p: 278) </li></ul>
<li> C11 standard (ISO/IEC 9899:2011): </li>
<ul><li> 7.26.4.4 The mtx_timedlock function (p: 381-382) </li></ul>
</ul>       <h3 id="See_also"> See also</h3> <table class="t-dsc-begin"> <tr class="t-dsc"> <td> <div><a href="../chrono/timespec" title="c/chrono/timespec"> <span class="t-lines"><span>timespec</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> time in seconds and nanoseconds <br><span class="t-mark">(struct)</span> </td>
</tr> <tr class="t-dsc"> <td> <div><a href="mtx_lock" title="c/thread/mtx lock"> <span class="t-lines"><span>mtx_lock</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 until locks a mutex <br> <span class="t-mark">(function)</span>  </td>
</tr> <tr class="t-dsc"> <td> <div><a href="mtx_trylock" title="c/thread/mtx trylock"> <span class="t-lines"><span>mtx_trylock</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> locks a mutex or returns without blocking if already locked <br> <span class="t-mark">(function)</span>  </td>
</tr> <tr class="t-dsc"> <td> <div><a href="mtx_unlock" title="c/thread/mtx unlock"> <span class="t-lines"><span>mtx_unlock</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> unlocks a mutex <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/timed_mutex/try_lock_until" title="cpp/thread/timed mutex/try lock until">C++ documentation</a></span> for <code>timed_mutex::try_lock_until</code> </td>
</tr> <tr class="t-dsc"> <td colspan="2"> <span><a href="https://en.cppreference.com/w/cpp/thread/recursive_timed_mutex/try_lock_until" title="cpp/thread/recursive timed mutex/try lock until">C++ documentation</a></span> for <code>recursive_timed_mutex::try_lock_until</code> </td>
</tr> </table> <h3 id="External_links"> External links</h3> <table> <tr> <td>
<a rel="nofollow" class="external text" href="https://www.gnu.org/software/libc/manual/html_node/ISO-C-Mutexes.html">GNU GCC Libc Manual: ISO-C-Mutexes</a> </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/mtx_timedlock" class="_attribution-link">https://en.cppreference.com/w/c/thread/mtx_timedlock</a>
  </p>
</div>