trAvis - MANAGER
Edit File: apr__shm_8h_source.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: apr_shm.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_shm.h</div> </div> </div><!--header--> <div class="contents"> <a href="apr__shm_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_SHM_H</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor"></span><span class="preprocessor">#define APR_SHM_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_shm.h</span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * @brief APR Shared Memory 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> <span class="preprocessor">#include "<a class="code" href="apr__perms__set_8h.html">apr_perms_set.h</a>"</span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#ifdef __cplusplus</span></div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor"></span><span class="comment"></span></div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">/**</span></div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> * @defgroup apr_shm Shared Memory Routines</span></div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * @ingroup APR </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">/**</span></div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * Private, platform-specific data struture representing a shared memory</span></div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * segment.</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__shm.html#ga79e8c16bdeaf7ade4ef0f935249e7c2f"> 44</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="group__apr__shm.html#ga79e8c16bdeaf7ade4ef0f935249e7c2f">apr_shm_t</a> <a class="code" href="group__apr__shm.html#ga79e8c16bdeaf7ade4ef0f935249e7c2f">apr_shm_t</a>;</div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"></span></div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">/**</span></div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * Create and make accessible a shared memory segment with default</span></div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * properties.</span></div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * @param m The shared memory structure to create.</span></div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * @param reqsize The desired size of the segment.</span></div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * @param filename The file to use for shared memory on platforms that</span></div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> * require it.</span></div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * @param pool the pool from which to allocate the shared memory</span></div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * structure.</span></div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> * @remark A note about Anonymous vs. Named shared memory segments:</span></div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * Not all plaforms support anonymous shared memory segments, but in</span></div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> * some cases it is prefered over other types of shared memory</span></div> <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> * implementations. Passing a NULL 'file' parameter to this function</span></div> <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> * will cause the subsystem to use anonymous shared memory segments.</span></div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> * If such a system is not available, APR_ENOTIMPL is returned.</span></div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * @remark A note about allocation sizes:</span></div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * On some platforms it is necessary to store some metainformation</span></div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> * about the segment within the actual segment. In order to supply</span></div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * the caller with the requested size it may be necessary for the</span></div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * implementation to request a slightly greater segment length</span></div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> * from the subsystem. In all cases, the apr_shm_baseaddr_get()</span></div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> * function will return the first usable byte of memory.</span></div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> * </span></div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> */</span></div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</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__shm.html#gac370c4943c22505ce2b0d57c51805480">apr_shm_create</a>(<a class="code" href="group__apr__shm.html#ga79e8c16bdeaf7ade4ef0f935249e7c2f">apr_shm_t</a> **m,</div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  apr_size_t reqsize,</div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  const <span class="keywordtype">char</span> *filename,</div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool);</div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"></span></div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment">/**</span></div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> * Special processing flags for apr_shm_create_ex() and apr_shm_attach_ex().</span></div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> */</span></div> <div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="group__apr__shm.html#ga47cc28ddc5f32cf904383b9e4f82825b"> 78</a></span> <span class="preprocessor">#define APR_SHM_NS_LOCAL 1 </span><span class="comment">/* Create or attach to named shared memory</span></div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * segment in the "Local" namespace on</span></div> <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * Windows. (Ignored on other platforms.)</span></div> <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * By default, the "Global" namespace is</span></div> <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> * used for privileged processes and the</span></div> <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> * "Local" namespace is used otherwise.</span></div> <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="preprocessor"></span><span class="preprocessor">#define APR_SHM_NS_GLOBAL 2 </span><span class="comment">/* Create or attach to named shared memory</span></div> <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> * segment in the "Global" namespace on</span></div> <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> * Windows. (Ignored on other platforms.)</span></div> <div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor"></span><span class="comment"></span></div> <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment">/**</span></div> <div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> * Create and make accessible a shared memory segment with platform-</span></div> <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> * specific processing.</span></div> <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> * @param m The shared memory structure to create.</span></div> <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> * @param reqsize The desired size of the segment.</span></div> <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> * @param filename The file to use for shared memory on platforms that</span></div> <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> * require it.</span></div> <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> * @param pool the pool from which to allocate the shared memory</span></div> <div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> * structure.</span></div> <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> * @param flags mask of APR_SHM_* (defined above)</span></div> <div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> * @remark A note about Anonymous vs. Named shared memory segments:</span></div> <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> * Not all plaforms support anonymous shared memory segments, but in</span></div> <div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> * some cases it is prefered over other types of shared memory</span></div> <div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * implementations. Passing a NULL 'file' parameter to this function</span></div> <div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * will cause the subsystem to use anonymous shared memory segments.</span></div> <div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> * If such a system is not available, APR_ENOTIMPL is returned.</span></div> <div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> * @remark A note about allocation sizes:</span></div> <div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> * On some platforms it is necessary to store some metainformation</span></div> <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> * about the segment within the actual segment. In order to supply</span></div> <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> * the caller with the requested size it may be necessary for the</span></div> <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * implementation to request a slightly greater segment length</span></div> <div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> * from the subsystem. In all cases, the apr_shm_baseaddr_get()</span></div> <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> * function will return the first usable byte of memory.</span></div> <div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> * </span></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> <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__shm.html#ga21baaa66956641e06e072501f61882e7">apr_shm_create_ex</a>(<a class="code" href="group__apr__shm.html#ga79e8c16bdeaf7ade4ef0f935249e7c2f">apr_shm_t</a> **m,</div> <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  apr_size_t reqsize,</div> <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  const <span class="keywordtype">char</span> *filename,</div> <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool,</div> <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  apr_int32_t flags);</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"> * Remove named resource associated with a shared memory segment,</span></div> <div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> * preventing attachments to the resource, but not destroying it.</span></div> <div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> * @param filename The filename associated with shared-memory segment which</span></div> <div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> * needs to be removed</span></div> <div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> * @param pool The pool used for file operations</span></div> <div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> * @remark This function is only supported on platforms which support</span></div> <div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> * name-based shared memory segments, and will return APR_ENOTIMPL on</span></div> <div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> * platforms without such support. Removing the file while the shm</span></div> <div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> * is in use is not entirely portable, caller may use this to enhance</span></div> <div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> * obscurity of the resource, but be prepared for the call to fail,</span></div> <div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> * and for concurrent attempts to create a resource of the same name</span></div> <div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> * to also fail. The pool cleanup of apr_shm_create (apr_shm_destroy)</span></div> <div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"> * also removes the named resource.</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> <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__shm.html#gaee8b7d9b952ff6157ddbb00fabb477e0">apr_shm_remove</a>(const <span class="keywordtype">char</span> *filename,</div> <div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool);</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> <span class="comment">/**</span></div> <div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> * Delete named resource associated with a shared memory segment,</span></div> <div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> * preventing attachments to the resource.</span></div> <div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> * @param m The shared memory segment structure to delete.</span></div> <div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> * @remark This function is only supported on platforms which support</span></div> <div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> * name-based shared memory segments, and will return APR_ENOTIMPL on</span></div> <div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> * platforms without such support. Removing the file while the shm</span></div> <div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> * is in use is not entirely portable, caller may use this to enhance</span></div> <div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> * obscurity of the resource, but be prepared for the call to fail,</span></div> <div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> * and for concurrent attempts to create a resource of the same name</span></div> <div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> * to also fail. The pool cleanup of apr_shm_create (apr_shm_destroy)</span></div> <div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> * also removes the named resource.</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>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__shm.html#gab5399f04b93193bead435217f46087fd">apr_shm_delete</a>(<a class="code" href="group__apr__shm.html#ga79e8c16bdeaf7ade4ef0f935249e7c2f">apr_shm_t</a> *m);</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"> * Destroy a shared memory segment and associated memory.</span></div> <div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> * @param m The shared memory segment structure to destroy.</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__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__shm.html#ga7de5b65a9c7d9840bfa289854f8d59d4">apr_shm_destroy</a>(<a class="code" href="group__apr__shm.html#ga79e8c16bdeaf7ade4ef0f935249e7c2f">apr_shm_t</a> *m);</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> <span class="comment"> * Attach to a shared memory segment that was created</span></div> <div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"> * by another process.</span></div> <div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> * @param m The shared memory structure to create.</span></div> <div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"> * @param filename The file used to create the original segment.</span></div> <div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"> * (This MUST match the original filename.)</span></div> <div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"> * @param pool the pool from which to allocate the shared memory</span></div> <div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> * structure for this process.</span></div> <div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"> */</span></div> <div class="line"><a name="l00169"></a><span class="lineno"> 169</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__shm.html#ga0e542941c280cb72b78e30d452464759">apr_shm_attach</a>(<a class="code" href="group__apr__shm.html#ga79e8c16bdeaf7ade4ef0f935249e7c2f">apr_shm_t</a> **m,</div> <div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  const <span class="keywordtype">char</span> *filename,</div> <div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool);</div> <div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"></span></div> <div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment">/**</span></div> <div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment"> * Attach to a shared memory segment that was created</span></div> <div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"> * by another process, with platform-specific processing.</span></div> <div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"> * @param m The shared memory structure to create.</span></div> <div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"> * @param filename The file used to create the original segment.</span></div> <div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"> * (This MUST match the original filename.)</span></div> <div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment"> * @param pool the pool from which to allocate the shared memory</span></div> <div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"> * structure for this process.</span></div> <div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"> * @param flags mask of APR_SHM_* (defined above)</span></div> <div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"> */</span></div> <div class="line"><a name="l00183"></a><span class="lineno"> 183</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__shm.html#ga088260723c96815610ff628f358d3630">apr_shm_attach_ex</a>(<a class="code" href="group__apr__shm.html#ga79e8c16bdeaf7ade4ef0f935249e7c2f">apr_shm_t</a> **m,</div> <div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  const <span class="keywordtype">char</span> *filename,</div> <div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool,</div> <div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  apr_int32_t flags);</div> <div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"></span></div> <div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment">/**</span></div> <div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"> * Detach from a shared memory segment without destroying it.</span></div> <div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"> * @param m The shared memory structure representing the segment</span></div> <div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment"> * to detach from.</span></div> <div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment"> */</span></div> <div class="line"><a name="l00193"></a><span class="lineno"> 193</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__shm.html#ga900095a06d3fdb4cdd04ca4449a9d42a">apr_shm_detach</a>(<a class="code" href="group__apr__shm.html#ga79e8c16bdeaf7ade4ef0f935249e7c2f">apr_shm_t</a> *m);</div> <div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment"></span></div> <div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment">/**</span></div> <div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"> * Retrieve the base address of the shared memory segment.</span></div> <div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"> * NOTE: This address is only usable within the callers address</span></div> <div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"> * space, since this API does not guarantee that other attaching</span></div> <div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"> * processes will maintain the same address mapping.</span></div> <div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment"> * @param m The shared memory segment from which to retrieve</span></div> <div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment"> * the base address.</span></div> <div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment"> * @return address, aligned by APR_ALIGN_DEFAULT.</span></div> <div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment"> */</span></div> <div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">void</span> *) <a class="code" href="group__apr__shm.html#gade739e1f5f4e88c93256a63ebfd47d4d">apr_shm_baseaddr_get</a>(const <a class="code" href="group__apr__shm.html#ga79e8c16bdeaf7ade4ef0f935249e7c2f">apr_shm_t</a> *m);</div> <div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment"></span></div> <div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment">/**</span></div> <div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment"> * Retrieve the length of a shared memory segment in bytes.</span></div> <div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment"> * @param m The shared memory segment from which to retrieve</span></div> <div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment"> * the segment length.</span></div> <div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment"> */</span></div> <div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(apr_size_t) <a class="code" href="group__apr__shm.html#ga557ae85d3f225620a77ad80caeaacac7">apr_shm_size_get</a>(const <a class="code" href="group__apr__shm.html#ga79e8c16bdeaf7ade4ef0f935249e7c2f">apr_shm_t</a> *m);</div> <div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment"></span></div> <div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment">/**</span></div> <div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment"> * Set shared memory permissions.</span></div> <div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment"> */</span></div> <div class="line"><a name="l00216"></a><span class="lineno"> 216</span> APR_PERMS_SET_IMPLEMENT(shm);</div> <div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment"></span></div> <div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment">/**</span></div> <div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment"> * Get the pool used by this shared memory segment.</span></div> <div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment"> */</span></div> <div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <a class="code" href="group__apr__pools.html#ga89ce1d55c7f0c39ea87c88eabd655394">APR_POOL_DECLARE_ACCESSOR</a>(shm);</div> <div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment"></span></div> <div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment">/** @} */</span> </div> <div class="line"><a name="l00224"></a><span class="lineno"> 224</span> </div> <div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="preprocessor">#ifdef __cplusplus</span></div> <div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="preprocessor"></span>}</div> <div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="preprocessor">#endif </span><span class="comment">/* APR_SHM_T */</span><span class="preprocessor"></span></div> <div class="ttc" id="group__apr__shm_html_gac370c4943c22505ce2b0d57c51805480"><div class="ttname"><a href="group__apr__shm.html#gac370c4943c22505ce2b0d57c51805480">apr_shm_create</a></div><div class="ttdeci">apr_status_t apr_shm_create(apr_shm_t **m, apr_size_t reqsize, const char *filename, apr_pool_t *pool)</div></div> <div class="ttc" id="group__apr__shm_html_ga557ae85d3f225620a77ad80caeaacac7"><div class="ttname"><a href="group__apr__shm.html#ga557ae85d3f225620a77ad80caeaacac7">apr_shm_size_get</a></div><div class="ttdeci">apr_size_t apr_shm_size_get(const apr_shm_t *m)</div></div> <div class="ttc" id="apr__perms__set_8h_html"><div class="ttname"><a href="apr__perms__set_8h.html">apr_perms_set.h</a></div><div class="ttdoc">APR Process Locking Routines. </div></div> <div class="ttc" id="group__apr__shm_html_gaee8b7d9b952ff6157ddbb00fabb477e0"><div class="ttname"><a href="group__apr__shm.html#gaee8b7d9b952ff6157ddbb00fabb477e0">apr_shm_remove</a></div><div class="ttdeci">apr_status_t apr_shm_remove(const char *filename, apr_pool_t *pool)</div></div> <div class="ttc" id="group__apr__shm_html_ga0e542941c280cb72b78e30d452464759"><div class="ttname"><a href="group__apr__shm.html#ga0e542941c280cb72b78e30d452464759">apr_shm_attach</a></div><div class="ttdeci">apr_status_t apr_shm_attach(apr_shm_t **m, const char *filename, apr_pool_t *pool)</div></div> <div class="ttc" id="group__apr__shm_html_gade739e1f5f4e88c93256a63ebfd47d4d"><div class="ttname"><a href="group__apr__shm.html#gade739e1f5f4e88c93256a63ebfd47d4d">apr_shm_baseaddr_get</a></div><div class="ttdeci">void * apr_shm_baseaddr_get(const apr_shm_t *m)</div></div> <div class="ttc" id="group__apr__shm_html_ga21baaa66956641e06e072501f61882e7"><div class="ttname"><a href="group__apr__shm.html#ga21baaa66956641e06e072501f61882e7">apr_shm_create_ex</a></div><div class="ttdeci">apr_status_t apr_shm_create_ex(apr_shm_t **m, apr_size_t reqsize, const char *filename, apr_pool_t *pool, apr_int32_t flags)</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:480</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__shm_html_ga79e8c16bdeaf7ade4ef0f935249e7c2f"><div class="ttname"><a href="group__apr__shm.html#ga79e8c16bdeaf7ade4ef0f935249e7c2f">apr_shm_t</a></div><div class="ttdeci">struct apr_shm_t apr_shm_t</div><div class="ttdef"><b>Definition:</b> apr_shm.h:44</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="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__shm_html_ga7de5b65a9c7d9840bfa289854f8d59d4"><div class="ttname"><a href="group__apr__shm.html#ga7de5b65a9c7d9840bfa289854f8d59d4">apr_shm_destroy</a></div><div class="ttdeci">apr_status_t apr_shm_destroy(apr_shm_t *m)</div></div> <div class="ttc" id="group__apr__shm_html_ga088260723c96815610ff628f358d3630"><div class="ttname"><a href="group__apr__shm.html#ga088260723c96815610ff628f358d3630">apr_shm_attach_ex</a></div><div class="ttdeci">apr_status_t apr_shm_attach_ex(apr_shm_t **m, const char *filename, apr_pool_t *pool, apr_int32_t flags)</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__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__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 class="ttc" id="group__apr__shm_html_gab5399f04b93193bead435217f46087fd"><div class="ttname"><a href="group__apr__shm.html#gab5399f04b93193bead435217f46087fd">apr_shm_delete</a></div><div class="ttdeci">apr_status_t apr_shm_delete(apr_shm_t *m)</div></div> <div class="ttc" id="group__apr__shm_html_ga900095a06d3fdb4cdd04ca4449a9d42a"><div class="ttname"><a href="group__apr__shm.html#ga900095a06d3fdb4cdd04ca4449a9d42a">apr_shm_detach</a></div><div class="ttdeci">apr_status_t apr_shm_detach(apr_shm_t *m)</div></div> </div><!-- fragment --></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>