<!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: apr_proc_mutex.h Source File</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 class="current"><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 id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">apr_proc_mutex.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="apr__proc__mutex_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* Licensed to the Apache Software Foundation (ASF) under one or more</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * this work for additional information regarding copyright ownership.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * (the "License"); you may not use this file except in compliance with</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * the License. You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * limitations under the License.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#ifndef APR_PROC_MUTEX_H</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor"></span><span class="preprocessor">#define APR_PROC_MUTEX_H</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor"></span><span class="comment"></span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * @file apr_proc_mutex.h</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * @brief APR Process Locking Routines</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "<a class="code" href="apr_8h.html">apr.h</a>"</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "<a class="code" href="apr__pools_8h.html">apr_pools.h</a>"</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="apr__errno_8h.html">apr_errno.h</a>"</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor"></span><span class="comment"></span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> * @defgroup apr_proc_mutex Process Locking Routines</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> * @ingroup APR </span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * @{</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"></span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">/** </span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * Enumerated potential types for APR process locking methods</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * @warning Check APR_HAS_foo_SERIALIZE defines to see if the platform supports</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * APR_LOCK_foo. Only APR_LOCK_DEFAULT is portable.</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="group__apr__proc__mutex.html#ga75dd95a48a1e855a87b509b522746ed4"> 44</a></span> <span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="group__apr__proc__mutex.html#gga75dd95a48a1e855a87b509b522746ed4ad9dad69d83d1e112054ad21a7e4e16b3"> 45</a></span>  <a class="code" href="group__apr__proc__mutex.html#gga75dd95a48a1e855a87b509b522746ed4ad9dad69d83d1e112054ad21a7e4e16b3">APR_LOCK_FCNTL</a>, <span class="comment">/**< fcntl() */</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="group__apr__proc__mutex.html#gga75dd95a48a1e855a87b509b522746ed4a1d06f73a37dae31233299401c9594b41"> 46</a></span>  <a class="code" href="group__apr__proc__mutex.html#gga75dd95a48a1e855a87b509b522746ed4a1d06f73a37dae31233299401c9594b41">APR_LOCK_FLOCK</a>, <span class="comment">/**< flock() */</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="group__apr__proc__mutex.html#gga75dd95a48a1e855a87b509b522746ed4a642536695bd4c233761a15d48b1d6487"> 47</a></span>  <a class="code" href="group__apr__proc__mutex.html#gga75dd95a48a1e855a87b509b522746ed4a642536695bd4c233761a15d48b1d6487">APR_LOCK_SYSVSEM</a>, <span class="comment">/**< System V Semaphores */</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="group__apr__proc__mutex.html#gga75dd95a48a1e855a87b509b522746ed4abd5e7cca2c9f6023b541131f3841057a"> 48</a></span>  <a class="code" href="group__apr__proc__mutex.html#gga75dd95a48a1e855a87b509b522746ed4abd5e7cca2c9f6023b541131f3841057a">APR_LOCK_PROC_PTHREAD</a>, <span class="comment">/**< POSIX pthread process-based locking */</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="group__apr__proc__mutex.html#gga75dd95a48a1e855a87b509b522746ed4a6d65d9d745e13d8759bd8f1057f27041"> 49</a></span>  <a class="code" href="group__apr__proc__mutex.html#gga75dd95a48a1e855a87b509b522746ed4a6d65d9d745e13d8759bd8f1057f27041">APR_LOCK_POSIXSEM</a>, <span class="comment">/**< POSIX semaphore process-based locking */</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="group__apr__proc__mutex.html#gga75dd95a48a1e855a87b509b522746ed4ae91fb435c45216bcf84f506db99d0f19"> 50</a></span>  <a class="code" href="group__apr__proc__mutex.html#gga75dd95a48a1e855a87b509b522746ed4ae91fb435c45216bcf84f506db99d0f19">APR_LOCK_DEFAULT</a> <span class="comment">/**< Use the default process lock */</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> } <a class="code" href="group__apr__proc__mutex.html#ga75dd95a48a1e855a87b509b522746ed4">apr_lockmech_e</a>;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"></span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">/** Opaque structure representing a process mutex. */</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2"> 54</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_mutex_t</a> <a class="code" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_mutex_t</a>;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment">/* Function definitions */</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"></span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> * Create and initialize a mutex that can be used to synchronize processes.</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> * @param mutex the memory address where the newly created mutex will be</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * stored.</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * @param fname A file name to use if the lock mechanism requires one. This</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> * argument should always be provided. The lock code itself will</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * determine if it should be used.</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * @param mech The mechanism to use for the interprocess lock, if any; one of</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> * <PRE></span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> * APR_LOCK_FCNTL</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> * APR_LOCK_FLOCK</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> * APR_LOCK_SYSVSEM</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> * APR_LOCK_POSIXSEM</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> * APR_LOCK_PROC_PTHREAD</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> * APR_LOCK_DEFAULT pick the default mechanism for the platform</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> * </PRE></span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> * @param pool the pool from which to allocate the mutex.</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> * @see apr_lockmech_e</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> * @warning Check APR_HAS_foo_SERIALIZE defines to see if the platform supports</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> * APR_LOCK_foo. Only APR_LOCK_DEFAULT is portable.</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__proc__mutex.html#ga57a0ad8cc6209dcbc8cf7c4bdf4a2c22">apr_proc_mutex_create</a>(<a class="code" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_mutex_t</a> **mutex,</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  const <span class="keywordtype">char</span> *fname,</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <a class="code" href="group__apr__proc__mutex.html#ga75dd95a48a1e855a87b509b522746ed4">apr_lockmech_e</a> mech,</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool);</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"></span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> * Re-open a mutex in a child process.</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> * @param mutex The newly re-opened mutex structure.</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> * @param fname A file name to use if the mutex mechanism requires one. This</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> * argument should always be provided. The mutex code itself will</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> * determine if it should be used. This filename should be the </span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> * same one that was passed to apr_proc_mutex_create().</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> * @param pool The pool to operate on.</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> * @remark This function must be called to maintain portability, even</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> * if the underlying lock mechanism does not require it.</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__proc__mutex.html#ga52c440b92eda07dc9c851a4e98f2ac83">apr_proc_mutex_child_init</a>(<a class="code" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_mutex_t</a> **mutex,</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  const <span class="keywordtype">char</span> *fname,</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool);</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"></span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> * Acquire the lock for the given mutex. If the mutex is already locked,</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> * the current thread will be put to sleep until the lock becomes available.</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> * @param mutex the mutex on which to acquire the lock.</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__proc__mutex.html#ga9af7c9eabf4f99a5a33b41dc322af06f">apr_proc_mutex_lock</a>(<a class="code" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_mutex_t</a> *mutex);</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"></span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> * Attempt to acquire the lock for the given mutex. If the mutex has already</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> * been acquired, the call returns immediately with APR_EBUSY. Note: it</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> * is important that the APR_STATUS_IS_EBUSY(s) macro be used to determine</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * if the return value was APR_EBUSY, for portability reasons.</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> * @param mutex the mutex on which to attempt the lock acquiring.</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__proc__mutex.html#ga7c41927ce5014374eb4fc66d410f9513">apr_proc_mutex_trylock</a>(<a class="code" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_mutex_t</a> *mutex);</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"></span></div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> * Release the lock for the given mutex.</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> * @param mutex the mutex from which to release the lock.</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__proc__mutex.html#ga4ecd9a73fbb0e6e6853e5d0769bbb183">apr_proc_mutex_unlock</a>(<a class="code" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_mutex_t</a> *mutex);</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"></span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> * Destroy the mutex and free the memory associated with the lock.</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> * @param mutex the mutex to destroy.</span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__proc__mutex.html#gaa692ccd799305e0166fb81f258870830">apr_proc_mutex_destroy</a>(<a class="code" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_mutex_t</a> *mutex);</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"></span></div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> * Destroy the mutex and free the memory associated with the lock.</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> * @param mutex the mutex to destroy.</span></div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> * @note This function is generally used to kill a cleanup on an already</span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> * created mutex</span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__proc__mutex.html#ga71ec4d283f58e893322f44116e6f8ea2">apr_proc_mutex_cleanup</a>(<span class="keywordtype">void</span> *mutex);</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"></span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> * Return the name of the lockfile for the mutex, or NULL</span></div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> * if the mutex doesn't use a lock file</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(const <span class="keywordtype">char</span> *) <a class="code" href="group__apr__proc__mutex.html#gad4dcc5ec2a5a6ede7be178e13f56377a">apr_proc_mutex_lockfile</a>(<a class="code" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_mutex_t</a> *mutex);</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"></span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> * Display the name of the mutex, as it relates to the actual method used.</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> * This matches the valid options for Apache's AcceptMutex directive</span></div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> * @param mutex the name of the mutex</span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(const <span class="keywordtype">char</span> *) <a class="code" href="group__apr__proc__mutex.html#ga3e5cf6b6fd0736502efd91312d50881c">apr_proc_mutex_name</a>(<a class="code" href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_mutex_t</a> *mutex);</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"></span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> * Display the name of the default mutex: APR_LOCK_DEFAULT</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(const <span class="keywordtype">char</span> *) <a class="code" href="group__apr__proc__mutex.html#gaf4425adc130f83784c552b6bc1563036">apr_proc_mutex_defname</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"></span></div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> * Get the pool used by this proc_mutex.</span></div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> * @return apr_pool_t the pool</span></div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <a class="code" href="group__apr__pools.html#ga89ce1d55c7f0c39ea87c88eabd655394">APR_POOL_DECLARE_ACCESSOR</a>(proc_mutex);</div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"></span></div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment">/** @} */</span></div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> </div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="preprocessor"></span>}</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="preprocessor">#endif </span><span class="comment">/* ! APR_PROC_MUTEX_H */</span><span class="preprocessor"></span></div>
<div class="ttc" id="group__apr__proc__mutex_html_gga75dd95a48a1e855a87b509b522746ed4a642536695bd4c233761a15d48b1d6487"><div class="ttname"><a href="group__apr__proc__mutex.html#gga75dd95a48a1e855a87b509b522746ed4a642536695bd4c233761a15d48b1d6487">APR_LOCK_SYSVSEM</a></div><div class="ttdef"><b>Definition:</b> apr_proc_mutex.h:47</div></div>
<div class="ttc" id="group__apr__proc__mutex_html_gad4dcc5ec2a5a6ede7be178e13f56377a"><div class="ttname"><a href="group__apr__proc__mutex.html#gad4dcc5ec2a5a6ede7be178e13f56377a">apr_proc_mutex_lockfile</a></div><div class="ttdeci">const char * apr_proc_mutex_lockfile(apr_proc_mutex_t *mutex)</div></div>
<div class="ttc" id="group__apr__proc__mutex_html_gga75dd95a48a1e855a87b509b522746ed4a6d65d9d745e13d8759bd8f1057f27041"><div class="ttname"><a href="group__apr__proc__mutex.html#gga75dd95a48a1e855a87b509b522746ed4a6d65d9d745e13d8759bd8f1057f27041">APR_LOCK_POSIXSEM</a></div><div class="ttdef"><b>Definition:</b> apr_proc_mutex.h:49</div></div>
<div class="ttc" id="group__apr__proc__mutex_html_gga75dd95a48a1e855a87b509b522746ed4abd5e7cca2c9f6023b541131f3841057a"><div class="ttname"><a href="group__apr__proc__mutex.html#gga75dd95a48a1e855a87b509b522746ed4abd5e7cca2c9f6023b541131f3841057a">APR_LOCK_PROC_PTHREAD</a></div><div class="ttdef"><b>Definition:</b> apr_proc_mutex.h:48</div></div>
<div class="ttc" id="group__apr__proc__mutex_html_gga75dd95a48a1e855a87b509b522746ed4ad9dad69d83d1e112054ad21a7e4e16b3"><div class="ttname"><a href="group__apr__proc__mutex.html#gga75dd95a48a1e855a87b509b522746ed4ad9dad69d83d1e112054ad21a7e4e16b3">APR_LOCK_FCNTL</a></div><div class="ttdef"><b>Definition:</b> apr_proc_mutex.h:45</div></div>
<div class="ttc" id="group__apr__proc__mutex_html_gga75dd95a48a1e855a87b509b522746ed4ae91fb435c45216bcf84f506db99d0f19"><div class="ttname"><a href="group__apr__proc__mutex.html#gga75dd95a48a1e855a87b509b522746ed4ae91fb435c45216bcf84f506db99d0f19">APR_LOCK_DEFAULT</a></div><div class="ttdef"><b>Definition:</b> apr_proc_mutex.h:50</div></div>
<div class="ttc" id="group__apr__proc__mutex_html_gaf4425adc130f83784c552b6bc1563036"><div class="ttname"><a href="group__apr__proc__mutex.html#gaf4425adc130f83784c552b6bc1563036">apr_proc_mutex_defname</a></div><div class="ttdeci">const char * apr_proc_mutex_defname(void)</div></div>
<div class="ttc" id="group__apr__platform_html_gad7b91b811a172bfa802603c2fb688f98"><div class="ttname"><a href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a></div><div class="ttdeci">#define APR_DECLARE(type)</div><div class="ttdef"><b>Definition:</b> apr.h:479</div></div>
<div class="ttc" id="group__apr__proc__mutex_html_ga52c440b92eda07dc9c851a4e98f2ac83"><div class="ttname"><a href="group__apr__proc__mutex.html#ga52c440b92eda07dc9c851a4e98f2ac83">apr_proc_mutex_child_init</a></div><div class="ttdeci">apr_status_t apr_proc_mutex_child_init(apr_proc_mutex_t **mutex, const char *fname, apr_pool_t *pool)</div></div>
<div class="ttc" id="group__apr__proc__mutex_html_gga75dd95a48a1e855a87b509b522746ed4a1d06f73a37dae31233299401c9594b41"><div class="ttname"><a href="group__apr__proc__mutex.html#gga75dd95a48a1e855a87b509b522746ed4a1d06f73a37dae31233299401c9594b41">APR_LOCK_FLOCK</a></div><div class="ttdef"><b>Definition:</b> apr_proc_mutex.h:46</div></div>
<div class="ttc" id="group__apr__proc__mutex_html_ga0fae3a1ab686cd1f252c6062e4c97bd2"><div class="ttname"><a href="group__apr__proc__mutex.html#ga0fae3a1ab686cd1f252c6062e4c97bd2">apr_proc_mutex_t</a></div><div class="ttdeci">struct apr_proc_mutex_t apr_proc_mutex_t</div><div class="ttdef"><b>Definition:</b> apr_proc_mutex.h:54</div></div>
<div class="ttc" id="apr__pools_8h_html"><div class="ttname"><a href="apr__pools_8h.html">apr_pools.h</a></div><div class="ttdoc">APR memory allocation. </div></div>
<div class="ttc" id="group__apr__proc__mutex_html_ga9af7c9eabf4f99a5a33b41dc322af06f"><div class="ttname"><a href="group__apr__proc__mutex.html#ga9af7c9eabf4f99a5a33b41dc322af06f">apr_proc_mutex_lock</a></div><div class="ttdeci">apr_status_t apr_proc_mutex_lock(apr_proc_mutex_t *mutex)</div></div>
<div class="ttc" id="group__apr__proc__mutex_html_ga57a0ad8cc6209dcbc8cf7c4bdf4a2c22"><div class="ttname"><a href="group__apr__proc__mutex.html#ga57a0ad8cc6209dcbc8cf7c4bdf4a2c22">apr_proc_mutex_create</a></div><div class="ttdeci">apr_status_t apr_proc_mutex_create(apr_proc_mutex_t **mutex, const char *fname, apr_lockmech_e mech, apr_pool_t *pool)</div></div>
<div class="ttc" id="apr__errno_8h_html"><div class="ttname"><a href="apr__errno_8h.html">apr_errno.h</a></div><div class="ttdoc">APR Error Codes. </div></div>
<div class="ttc" id="group__apr__proc__mutex_html_ga75dd95a48a1e855a87b509b522746ed4"><div class="ttname"><a href="group__apr__proc__mutex.html#ga75dd95a48a1e855a87b509b522746ed4">apr_lockmech_e</a></div><div class="ttdeci">apr_lockmech_e</div><div class="ttdef"><b>Definition:</b> apr_proc_mutex.h:44</div></div>
<div class="ttc" id="apr_8h_html"><div class="ttname"><a href="apr_8h.html">apr.h</a></div><div class="ttdoc">APR Platform Definitions. </div></div>
<div class="ttc" id="group__apr__proc__mutex_html_ga3e5cf6b6fd0736502efd91312d50881c"><div class="ttname"><a href="group__apr__proc__mutex.html#ga3e5cf6b6fd0736502efd91312d50881c">apr_proc_mutex_name</a></div><div class="ttdeci">const char * apr_proc_mutex_name(apr_proc_mutex_t *mutex)</div></div>
<div class="ttc" id="group__apr__proc__mutex_html_ga4ecd9a73fbb0e6e6853e5d0769bbb183"><div class="ttname"><a href="group__apr__proc__mutex.html#ga4ecd9a73fbb0e6e6853e5d0769bbb183">apr_proc_mutex_unlock</a></div><div class="ttdeci">apr_status_t apr_proc_mutex_unlock(apr_proc_mutex_t *mutex)</div></div>
<div class="ttc" id="group__apr__pools_html_gaf137f28edcf9a086cd6bc36c20d7cdfb"><div class="ttname"><a href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a></div><div class="ttdeci">struct apr_pool_t apr_pool_t</div><div class="ttdef"><b>Definition:</b> apr_pools.h:60</div></div>
<div class="ttc" id="group__apr__proc__mutex_html_gaa692ccd799305e0166fb81f258870830"><div class="ttname"><a href="group__apr__proc__mutex.html#gaa692ccd799305e0166fb81f258870830">apr_proc_mutex_destroy</a></div><div class="ttdeci">apr_status_t apr_proc_mutex_destroy(apr_proc_mutex_t *mutex)</div></div>
<div class="ttc" id="group__apr__errno_html_gaf76ee4543247e9fb3f3546203e590a6c"><div class="ttname"><a href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a></div><div class="ttdeci">int apr_status_t</div><div class="ttdef"><b>Definition:</b> apr_errno.h:44</div></div>
<div class="ttc" id="group__apr__proc__mutex_html_ga71ec4d283f58e893322f44116e6f8ea2"><div class="ttname"><a href="group__apr__proc__mutex.html#ga71ec4d283f58e893322f44116e6f8ea2">apr_proc_mutex_cleanup</a></div><div class="ttdeci">apr_status_t apr_proc_mutex_cleanup(void *mutex)</div></div>
<div class="ttc" id="group__apr__proc__mutex_html_ga7c41927ce5014374eb4fc66d410f9513"><div class="ttname"><a href="group__apr__proc__mutex.html#ga7c41927ce5014374eb4fc66d410f9513">apr_proc_mutex_trylock</a></div><div class="ttdeci">apr_status_t apr_proc_mutex_trylock(apr_proc_mutex_t *mutex)</div></div>
<div class="ttc" id="group__apr__pools_html_ga89ce1d55c7f0c39ea87c88eabd655394"><div class="ttname"><a href="group__apr__pools.html#ga89ce1d55c7f0c39ea87c88eabd655394">APR_POOL_DECLARE_ACCESSOR</a></div><div class="ttdeci">#define APR_POOL_DECLARE_ACCESSOR(type)</div><div class="ttdef"><b>Definition:</b> apr_pools.h:81</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Nov 30 2013 15:32:17 for Apache Portable Runtime 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>
