<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Apache Portable Runtime: Thread Mutex Routines</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Apache Portable Runtime
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Thread Mutex Routines<div class="ingroups"><a class="el" href="group___a_p_r.html">Apache Portability Runtime library</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga579050872f9aff06e773b084264f7d06"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__thread__mutex.html#ga579050872f9aff06e773b084264f7d06">APR_THREAD_MUTEX_DEFAULT</a>   0x0</td></tr>
<tr class="separator:ga579050872f9aff06e773b084264f7d06"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf421e0445dbc3c739130f5f6544c2e78"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__thread__mutex.html#gaf421e0445dbc3c739130f5f6544c2e78">APR_THREAD_MUTEX_NESTED</a>   0x1</td></tr>
<tr class="separator:gaf421e0445dbc3c739130f5f6544c2e78"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac31107f3db115edc0c26ea48943c6a16"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__thread__mutex.html#gac31107f3db115edc0c26ea48943c6a16">APR_THREAD_MUTEX_UNNESTED</a>   0x2</td></tr>
<tr class="separator:gac31107f3db115edc0c26ea48943c6a16"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga95712060ba3a192036416e1ccef1db75"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__apr__thread__mutex.html#ga95712060ba3a192036416e1ccef1db75">apr_thread_mutex_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__thread__mutex.html#ga95712060ba3a192036416e1ccef1db75">apr_thread_mutex_t</a></td></tr>
<tr class="separator:ga95712060ba3a192036416e1ccef1db75"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga927e99580a669f577fbcb6508814ff12"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__thread__mutex.html#ga927e99580a669f577fbcb6508814ff12">apr_thread_mutex_create</a> (<a class="el" href="group__apr__thread__mutex.html#ga95712060ba3a192036416e1ccef1db75">apr_thread_mutex_t</a> **mutex, unsigned int flags, <a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool)</td></tr>
<tr class="separator:ga927e99580a669f577fbcb6508814ff12"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1430fd10d8d260c0e3832c959742a977"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__thread__mutex.html#ga1430fd10d8d260c0e3832c959742a977">apr_thread_mutex_lock</a> (<a class="el" href="group__apr__thread__mutex.html#ga95712060ba3a192036416e1ccef1db75">apr_thread_mutex_t</a> *mutex)</td></tr>
<tr class="separator:ga1430fd10d8d260c0e3832c959742a977"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6ac9c8ebee83ff89416f00231a858798"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__thread__mutex.html#ga6ac9c8ebee83ff89416f00231a858798">apr_thread_mutex_trylock</a> (<a class="el" href="group__apr__thread__mutex.html#ga95712060ba3a192036416e1ccef1db75">apr_thread_mutex_t</a> *mutex)</td></tr>
<tr class="separator:ga6ac9c8ebee83ff89416f00231a858798"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga74e58f753737283f9b826d8cdcbcb4bf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__thread__mutex.html#ga74e58f753737283f9b826d8cdcbcb4bf">apr_thread_mutex_unlock</a> (<a class="el" href="group__apr__thread__mutex.html#ga95712060ba3a192036416e1ccef1db75">apr_thread_mutex_t</a> *mutex)</td></tr>
<tr class="separator:ga74e58f753737283f9b826d8cdcbcb4bf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae80e6f9c2a2fbaa94f5a6954e02118f4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__thread__mutex.html#gae80e6f9c2a2fbaa94f5a6954e02118f4">apr_thread_mutex_destroy</a> (<a class="el" href="group__apr__thread__mutex.html#ga95712060ba3a192036416e1ccef1db75">apr_thread_mutex_t</a> *mutex)</td></tr>
<tr class="separator:gae80e6f9c2a2fbaa94f5a6954e02118f4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafec9362d92f8bd67660b97cb3c246544"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__thread__mutex.html#gafec9362d92f8bd67660b97cb3c246544">apr_thread_mutex_pool_get</a> (const <a class="el" href="group__apr__thread__mutex.html#ga95712060ba3a192036416e1ccef1db75">apr_thread_mutex_t</a> *thethread_mutex)</td></tr>
<tr class="separator:gafec9362d92f8bd67660b97cb3c246544"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga579050872f9aff06e773b084264f7d06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga579050872f9aff06e773b084264f7d06">◆ </a></span>APR_THREAD_MUTEX_DEFAULT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_THREAD_MUTEX_DEFAULT   0x0</td>
</tr>
</table>
</div><div class="memdoc">
<p>platform-optimal lock behavior </p>
</div>
</div>
<a id="gaf421e0445dbc3c739130f5f6544c2e78"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf421e0445dbc3c739130f5f6544c2e78">◆ </a></span>APR_THREAD_MUTEX_NESTED</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_THREAD_MUTEX_NESTED   0x1</td>
</tr>
</table>
</div><div class="memdoc">
<p>enable nested (recursive) locks </p>
</div>
</div>
<a id="gac31107f3db115edc0c26ea48943c6a16"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac31107f3db115edc0c26ea48943c6a16">◆ </a></span>APR_THREAD_MUTEX_UNNESTED</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_THREAD_MUTEX_UNNESTED   0x2</td>
</tr>
</table>
</div><div class="memdoc">
<p>disable nested locks </p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga95712060ba3a192036416e1ccef1db75"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga95712060ba3a192036416e1ccef1db75">◆ </a></span>apr_thread_mutex_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="group__apr__thread__mutex.html#ga95712060ba3a192036416e1ccef1db75">apr_thread_mutex_t</a> <a class="el" href="group__apr__thread__mutex.html#ga95712060ba3a192036416e1ccef1db75">apr_thread_mutex_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Opaque thread-local mutex structure </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga927e99580a669f577fbcb6508814ff12"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga927e99580a669f577fbcb6508814ff12">◆ </a></span>apr_thread_mutex_create()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_thread_mutex_create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__thread__mutex.html#ga95712060ba3a192036416e1ccef1db75">apr_thread_mutex_t</a> ** </td>
<td class="paramname"><em>mutex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td>
<td class="paramname"><em>pool</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create and initialize a mutex that can be used to synchronize threads. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mutex</td><td>the memory address where the newly created mutex will be stored. </td></tr>
<tr><td class="paramname">flags</td><td>Or'ed value of: <pre>
APR_THREAD_MUTEX_DEFAULT platform-optimal lock behavior.
APR_THREAD_MUTEX_NESTED enable nested (recursive) locks.
APR_THREAD_MUTEX_UNNESTED disable nested locks (non-recursive).
</pre> </td></tr>
<tr><td class="paramname">pool</td><td>the pool from which to allocate the mutex. </td></tr>
</table>
</dd>
</dl>
<dl class="section warning"><dt>Warning</dt><dd>Be cautious in using APR_THREAD_MUTEX_DEFAULT. While this is the most optimal mutex based on a given platform's performance characteristics, it will behave as either a nested or an unnested lock. </dd></dl>
</div>
</div>
<a id="gae80e6f9c2a2fbaa94f5a6954e02118f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae80e6f9c2a2fbaa94f5a6954e02118f4">◆ </a></span>apr_thread_mutex_destroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_thread_mutex_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__thread__mutex.html#ga95712060ba3a192036416e1ccef1db75">apr_thread_mutex_t</a> * </td>
<td class="paramname"><em>mutex</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy the mutex and free the memory associated with the lock. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mutex</td><td>the mutex to destroy. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga1430fd10d8d260c0e3832c959742a977"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1430fd10d8d260c0e3832c959742a977">◆ </a></span>apr_thread_mutex_lock()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_thread_mutex_lock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__thread__mutex.html#ga95712060ba3a192036416e1ccef1db75">apr_thread_mutex_t</a> * </td>
<td class="paramname"><em>mutex</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Acquire the lock for the given mutex. If the mutex is already locked, the current thread will be put to sleep until the lock becomes available. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mutex</td><td>the mutex on which to acquire the lock. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gafec9362d92f8bd67660b97cb3c246544"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafec9362d92f8bd67660b97cb3c246544">◆ </a></span>apr_thread_mutex_pool_get()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a>* apr_thread_mutex_pool_get </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__apr__thread__mutex.html#ga95712060ba3a192036416e1ccef1db75">apr_thread_mutex_t</a> * </td>
<td class="paramname"><em>thethread_mutex</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the pool used by this thread_mutex. </p><dl class="section return"><dt>Returns</dt><dd>apr_pool_t the pool </dd></dl>
</div>
</div>
<a id="ga6ac9c8ebee83ff89416f00231a858798"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6ac9c8ebee83ff89416f00231a858798">◆ </a></span>apr_thread_mutex_trylock()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_thread_mutex_trylock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__thread__mutex.html#ga95712060ba3a192036416e1ccef1db75">apr_thread_mutex_t</a> * </td>
<td class="paramname"><em>mutex</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Attempt to acquire the lock for the given mutex. If the mutex has already been acquired, the call returns immediately with APR_EBUSY. Note: it is important that the <a class="el" href="group___a_p_r___s_t_a_t_u_s___i_s.html#gabb92ad7b6ef304132de70e9e5cbaa896">APR_STATUS_IS_EBUSY(s)</a> macro be used to determine if the return value was APR_EBUSY, for portability reasons. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mutex</td><td>the mutex on which to attempt the lock acquiring. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga74e58f753737283f9b826d8cdcbcb4bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga74e58f753737283f9b826d8cdcbcb4bf">◆ </a></span>apr_thread_mutex_unlock()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_thread_mutex_unlock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__thread__mutex.html#ga95712060ba3a192036416e1ccef1db75">apr_thread_mutex_t</a> * </td>
<td class="paramname"><em>mutex</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Release the lock for the given mutex. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mutex</td><td>the mutex from which to release the lock. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
