trAvis - MANAGER
Edit File: group__apr__proc__mutex.html
<!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.5"/> <title>Apache Portable Runtime: Process Locking 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/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </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 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.5 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> </div><!-- top --> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></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="#typedef-members">Typedefs</a> | <a href="#enum-members">Enumerations</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">Process Locking 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="typedef-members"></a> Typedefs</h2></td></tr> <tr class="memitem:ga0fae3a1ab686cd1f252c6062e4c97bd2"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_mutex_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_mutex_t</a></td></tr> <tr class="separator:ga0fae3a1ab686cd1f252c6062e4c97bd2"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> Enumerations</h2></td></tr> <tr class="memitem:ga75dd95a48a1e855a87b509b522746ed4"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__proc__mutex.html#ga75dd95a48a1e855a87b509b522746ed4">apr_lockmech_e</a> { <br/>   <a class="el" href="group__apr__proc__mutex.html#gga75dd95a48a1e855a87b509b522746ed4ad9dad69d83d1e112054ad21a7e4e16b3">APR_LOCK_FCNTL</a>, <a class="el" href="group__apr__proc__mutex.html#gga75dd95a48a1e855a87b509b522746ed4a1d06f73a37dae31233299401c9594b41">APR_LOCK_FLOCK</a>, <a class="el" href="group__apr__proc__mutex.html#gga75dd95a48a1e855a87b509b522746ed4a642536695bd4c233761a15d48b1d6487">APR_LOCK_SYSVSEM</a>, <a class="el" href="group__apr__proc__mutex.html#gga75dd95a48a1e855a87b509b522746ed4abd5e7cca2c9f6023b541131f3841057a">APR_LOCK_PROC_PTHREAD</a>, <br/>   <a class="el" href="group__apr__proc__mutex.html#gga75dd95a48a1e855a87b509b522746ed4a6d65d9d745e13d8759bd8f1057f27041">APR_LOCK_POSIXSEM</a>, <a class="el" href="group__apr__proc__mutex.html#gga75dd95a48a1e855a87b509b522746ed4ae91fb435c45216bcf84f506db99d0f19">APR_LOCK_DEFAULT</a> <br/> }</td></tr> <tr class="separator:ga75dd95a48a1e855a87b509b522746ed4"><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:ga57a0ad8cc6209dcbc8cf7c4bdf4a2c22"><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__proc__mutex.html#ga57a0ad8cc6209dcbc8cf7c4bdf4a2c22">apr_proc_mutex_create</a> (<a class="el" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_mutex_t</a> **mutex, const char *fname, <a class="el" href="group__apr__proc__mutex.html#ga75dd95a48a1e855a87b509b522746ed4">apr_lockmech_e</a> mech, <a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool)</td></tr> <tr class="separator:ga57a0ad8cc6209dcbc8cf7c4bdf4a2c22"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga52c440b92eda07dc9c851a4e98f2ac83"><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__proc__mutex.html#ga52c440b92eda07dc9c851a4e98f2ac83">apr_proc_mutex_child_init</a> (<a class="el" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_mutex_t</a> **mutex, const char *fname, <a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool)</td></tr> <tr class="separator:ga52c440b92eda07dc9c851a4e98f2ac83"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga9af7c9eabf4f99a5a33b41dc322af06f"><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__proc__mutex.html#ga9af7c9eabf4f99a5a33b41dc322af06f">apr_proc_mutex_lock</a> (<a class="el" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_mutex_t</a> *mutex)</td></tr> <tr class="separator:ga9af7c9eabf4f99a5a33b41dc322af06f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga7c41927ce5014374eb4fc66d410f9513"><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__proc__mutex.html#ga7c41927ce5014374eb4fc66d410f9513">apr_proc_mutex_trylock</a> (<a class="el" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_mutex_t</a> *mutex)</td></tr> <tr class="separator:ga7c41927ce5014374eb4fc66d410f9513"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga4ecd9a73fbb0e6e6853e5d0769bbb183"><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__proc__mutex.html#ga4ecd9a73fbb0e6e6853e5d0769bbb183">apr_proc_mutex_unlock</a> (<a class="el" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_mutex_t</a> *mutex)</td></tr> <tr class="separator:ga4ecd9a73fbb0e6e6853e5d0769bbb183"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaa692ccd799305e0166fb81f258870830"><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__proc__mutex.html#gaa692ccd799305e0166fb81f258870830">apr_proc_mutex_destroy</a> (<a class="el" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_mutex_t</a> *mutex)</td></tr> <tr class="separator:gaa692ccd799305e0166fb81f258870830"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga71ec4d283f58e893322f44116e6f8ea2"><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__proc__mutex.html#ga71ec4d283f58e893322f44116e6f8ea2">apr_proc_mutex_cleanup</a> (void *mutex)</td></tr> <tr class="separator:ga71ec4d283f58e893322f44116e6f8ea2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gad4dcc5ec2a5a6ede7be178e13f56377a"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__proc__mutex.html#gad4dcc5ec2a5a6ede7be178e13f56377a">apr_proc_mutex_lockfile</a> (<a class="el" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_mutex_t</a> *mutex)</td></tr> <tr class="separator:gad4dcc5ec2a5a6ede7be178e13f56377a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga9ac3c4e335f725b12fe31c9cbe9ed3c5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__proc__mutex.html#ga75dd95a48a1e855a87b509b522746ed4">apr_lockmech_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__proc__mutex.html#ga9ac3c4e335f725b12fe31c9cbe9ed3c5">apr_proc_mutex_mech</a> (<a class="el" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_mutex_t</a> *mutex)</td></tr> <tr class="separator:ga9ac3c4e335f725b12fe31c9cbe9ed3c5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga3e5cf6b6fd0736502efd91312d50881c"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__proc__mutex.html#ga3e5cf6b6fd0736502efd91312d50881c">apr_proc_mutex_name</a> (<a class="el" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_mutex_t</a> *mutex)</td></tr> <tr class="separator:ga3e5cf6b6fd0736502efd91312d50881c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaf4425adc130f83784c552b6bc1563036"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__proc__mutex.html#gaf4425adc130f83784c552b6bc1563036">apr_proc_mutex_defname</a> (void)</td></tr> <tr class="separator:gaf4425adc130f83784c552b6bc1563036"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga160e03376aafa98c41639d7917c97e98"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__proc__mutex.html#ga160e03376aafa98c41639d7917c97e98">APR_PERMS_SET_IMPLEMENT</a> (proc_mutex)</td></tr> <tr class="separator:ga160e03376aafa98c41639d7917c97e98"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga9d7eda31ec4ad2183ddfcbff2f07daf9"><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__proc__mutex.html#ga9d7eda31ec4ad2183ddfcbff2f07daf9">apr_proc_mutex_pool_get</a> (const <a class="el" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_mutex_t</a> *theproc_mutex)</td></tr> <tr class="separator:ga9d7eda31ec4ad2183ddfcbff2f07daf9"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <h2 class="groupheader">Typedef Documentation</h2> <a class="anchor" id="ga0fae3a1ab686cd1f252c6062e4c97bd2"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_mutex_t</a> <a class="el" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_mutex_t</a></td> </tr> </table> </div><div class="memdoc"> <p>Opaque structure representing a process mutex. </p> </div> </div> <h2 class="groupheader">Enumeration Type Documentation</h2> <a class="anchor" id="ga75dd95a48a1e855a87b509b522746ed4"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="group__apr__proc__mutex.html#ga75dd95a48a1e855a87b509b522746ed4">apr_lockmech_e</a></td> </tr> </table> </div><div class="memdoc"> <p>Enumerated potential types for APR process locking methods </p> <dl class="section warning"><dt>Warning</dt><dd>Check APR_HAS_foo_SERIALIZE defines to see if the platform supports APR_LOCK_foo. Only APR_LOCK_DEFAULT is portable. </dd></dl> <table class="fieldtable"> <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga75dd95a48a1e855a87b509b522746ed4ad9dad69d83d1e112054ad21a7e4e16b3"></a>APR_LOCK_FCNTL</em> </td><td class="fielddoc"> <p>fcntl() </p> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="gga75dd95a48a1e855a87b509b522746ed4a1d06f73a37dae31233299401c9594b41"></a>APR_LOCK_FLOCK</em> </td><td class="fielddoc"> <p>flock() </p> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="gga75dd95a48a1e855a87b509b522746ed4a642536695bd4c233761a15d48b1d6487"></a>APR_LOCK_SYSVSEM</em> </td><td class="fielddoc"> <p>System V Semaphores </p> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="gga75dd95a48a1e855a87b509b522746ed4abd5e7cca2c9f6023b541131f3841057a"></a>APR_LOCK_PROC_PTHREAD</em> </td><td class="fielddoc"> <p>POSIX pthread process-based locking </p> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="gga75dd95a48a1e855a87b509b522746ed4a6d65d9d745e13d8759bd8f1057f27041"></a>APR_LOCK_POSIXSEM</em> </td><td class="fielddoc"> <p>POSIX semaphore process-based locking </p> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="gga75dd95a48a1e855a87b509b522746ed4ae91fb435c45216bcf84f506db99d0f19"></a>APR_LOCK_DEFAULT</em> </td><td class="fielddoc"> <p>Use the default process lock </p> </td></tr> </table> </div> </div> <h2 class="groupheader">Function Documentation</h2> <a class="anchor" id="ga160e03376aafa98c41639d7917c97e98"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">APR_PERMS_SET_IMPLEMENT </td> <td>(</td> <td class="paramtype">proc_mutex </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Set mutex permissions. </p> </div> </div> <a class="anchor" id="ga52c440b92eda07dc9c851a4e98f2ac83"></a> <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_proc_mutex_child_init </td> <td>(</td> <td class="paramtype"><a class="el" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_mutex_t</a> ** </td> <td class="paramname"><em>mutex</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>fname</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>Re-open a mutex in a child process. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">mutex</td><td>The newly re-opened mutex structure. </td></tr> <tr><td class="paramname">fname</td><td>A file name to use if the mutex mechanism requires one. This argument should always be provided. The mutex code itself will determine if it should be used. This filename should be the same one that was passed to <a class="el" href="group__apr__proc__mutex.html#ga57a0ad8cc6209dcbc8cf7c4bdf4a2c22">apr_proc_mutex_create()</a>. </td></tr> <tr><td class="paramname">pool</td><td>The pool to operate on. </td></tr> </table> </dd> </dl> <dl class="section remark"><dt>Remarks</dt><dd>This function must be called to maintain portability, even if the underlying lock mechanism does not require it. </dd></dl> </div> </div> <a class="anchor" id="ga71ec4d283f58e893322f44116e6f8ea2"></a> <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_proc_mutex_cleanup </td> <td>(</td> <td class="paramtype">void * </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> <dl class="section note"><dt>Note</dt><dd>This function is generally used to kill a cleanup on an already created mutex </dd></dl> </div> </div> <a class="anchor" id="ga57a0ad8cc6209dcbc8cf7c4bdf4a2c22"></a> <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_proc_mutex_create </td> <td>(</td> <td class="paramtype"><a class="el" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_mutex_t</a> ** </td> <td class="paramname"><em>mutex</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>fname</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="group__apr__proc__mutex.html#ga75dd95a48a1e855a87b509b522746ed4">apr_lockmech_e</a> </td> <td class="paramname"><em>mech</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 processes. </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">fname</td><td>A file name to use if the lock mechanism requires one. This argument should always be provided. The lock code itself will determine if it should be used. </td></tr> <tr><td class="paramname">mech</td><td>The mechanism to use for the interprocess lock, if any; one of <pre> APR_LOCK_FCNTL APR_LOCK_FLOCK APR_LOCK_SYSVSEM APR_LOCK_POSIXSEM APR_LOCK_PROC_PTHREAD APR_LOCK_DEFAULT pick the default mechanism for the platform </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 see"><dt>See Also</dt><dd><a class="el" href="group__apr__proc__mutex.html#ga75dd95a48a1e855a87b509b522746ed4">apr_lockmech_e</a> </dd></dl> <dl class="section warning"><dt>Warning</dt><dd>Check APR_HAS_foo_SERIALIZE defines to see if the platform supports APR_LOCK_foo. Only APR_LOCK_DEFAULT is portable. </dd></dl> </div> </div> <a class="anchor" id="gaf4425adc130f83784c552b6bc1563036"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* apr_proc_mutex_defname </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Display the name of the default mutex: APR_LOCK_DEFAULT </p> </div> </div> <a class="anchor" id="gaa692ccd799305e0166fb81f258870830"></a> <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_proc_mutex_destroy </td> <td>(</td> <td class="paramtype"><a class="el" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_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 class="anchor" id="ga9af7c9eabf4f99a5a33b41dc322af06f"></a> <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_proc_mutex_lock </td> <td>(</td> <td class="paramtype"><a class="el" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_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 class="anchor" id="gad4dcc5ec2a5a6ede7be178e13f56377a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* apr_proc_mutex_lockfile </td> <td>(</td> <td class="paramtype"><a class="el" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_mutex_t</a> * </td> <td class="paramname"><em>mutex</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Return the name of the lockfile for the mutex, or NULL if the mutex doesn't use a lock file </p> </div> </div> <a class="anchor" id="ga9ac3c4e335f725b12fe31c9cbe9ed3c5"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__apr__proc__mutex.html#ga75dd95a48a1e855a87b509b522746ed4">apr_lockmech_e</a> apr_proc_mutex_mech </td> <td>(</td> <td class="paramtype"><a class="el" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_mutex_t</a> * </td> <td class="paramname"><em>mutex</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Get the mechanism of the mutex, as it relates to the actual method used for the underlying apr_proc_mutex_t. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">mutex</td><td>the mutex to get the mechanism from. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ga3e5cf6b6fd0736502efd91312d50881c"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* apr_proc_mutex_name </td> <td>(</td> <td class="paramtype"><a class="el" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_mutex_t</a> * </td> <td class="paramname"><em>mutex</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Get the mechanism's name of the mutex, as it relates to the actual method used for the underlying apr_proc_mutex_t. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">mutex</td><td>the mutex to get the mechanism's name from. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ga9d7eda31ec4ad2183ddfcbff2f07daf9"></a> <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_proc_mutex_pool_get </td> <td>(</td> <td class="paramtype">const <a class="el" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_mutex_t</a> * </td> <td class="paramname"><em>theproc_mutex</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Get the pool used by this proc_mutex. </p> <dl class="section return"><dt>Returns</dt><dd>apr_pool_t the pool </dd></dl> </div> </div> <a class="anchor" id="ga7c41927ce5014374eb4fc66d410f9513"></a> <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_proc_mutex_trylock </td> <td>(</td> <td class="paramtype"><a class="el" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_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 class="anchor" id="ga4ecd9a73fbb0e6e6853e5d0769bbb183"></a> <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_proc_mutex_unlock </td> <td>(</td> <td class="paramtype"><a class="el" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_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.5 </small></address> </body> </html>