/usr/share/doc/libucommon-dev/a00079.html is in libucommon-doc 3.2.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 | <!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"/>
<title>UCommon: ucc::MappedReuse Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="a00214.html">ucc</a>::<a class="el" href="a00079.html">MappedReuse</a>
</div>
</div>
<div class="contents">
<h1>ucc::MappedReuse Class Reference</h1><!-- doxytag: class="ucc::MappedReuse" --><!-- doxytag: inherits="ucc::ReusableAllocator,ucc::MappedMemory" -->
<p>Map a reusable allocator over a named shared memory segment.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00196_source.html">mapped.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucc::MappedReuse:</div>
<div class="dynsection">
<div class="center"><img src="a00436.png" border="0" usemap="#ucc_1_1_mapped_reuse_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1_mapped_reuse_inherit__map" id="ucc_1_1_mapped_reuse_inherit__map">
<area shape="rect" id="node9" href="a00076.html" title="Template class to map typed resusble objects into shared memory heap." alt="" coords="88,237,272,267"/><area shape="rect" id="node2" href="a00112.html" title="Class for resource bound memory pools between threads." alt="" coords="5,83,171,112"/><area shape="rect" id="node4" href="a00040.html" title="The conditional is a common base for other thread synchronizing classes." alt="" coords="27,5,149,35"/><area shape="rect" id="node6" href="a00078.html" title="Construct or access a named section of memory." alt="" coords="195,83,349,112"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucc::MappedReuse:</div>
<div class="dynsection">
<div class="center"><img src="a00437.png" border="0" usemap="#ucc_1_1_mapped_reuse_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1_mapped_reuse_coll__map" id="ucc_1_1_mapped_reuse_coll__map">
<area shape="rect" id="node2" href="a00112.html" title="Class for resource bound memory pools between threads." alt="" coords="35,283,200,312"/><area shape="rect" id="node4" href="a00040.html" title="The conditional is a common base for other thread synchronizing classes." alt="" coords="5,187,128,216"/><area shape="rect" id="node6" href="a00113.html" title="Reusable objects for forming private heaps." alt="" coords="152,187,301,216"/><area shape="rect" id="node8" href="a00069.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="160,96,293,125"/><area shape="rect" id="node10" href="a00093.html" title="A common base class for all managed objects." alt="" coords="180,5,273,35"/><area shape="rect" id="node13" href="a00078.html" title="Construct or access a named section of memory." alt="" coords="224,283,379,312"/><area shape="rect" id="node15" href="a00086.html" title="Generic non-recursive exclusive lock class." alt="" coords="403,283,496,312"/><area shape="rect" id="node17" href="a00052.html" title="An exclusive locking protocol interface base." alt="" coords="395,187,504,216"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00079.html#ad5c846bc7688456dd2351547aed6539b">avail</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check whether there are objects available to be allocated. <a href="#ad5c846bc7688456dd2351547aed6539b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00113.html">ReusableObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00079.html#a248272488eeaae52e13bc470854f0424">get</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request a reusable object from the free list or mapped space. <a href="#a248272488eeaae52e13bc470854f0424"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00113.html">ReusableObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00079.html#aab398502f82432593fb03e51b57f3788">getLocked</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to get an object from the reuse pool when the mutex lock is already held. <a href="#aab398502f82432593fb03e51b57f3788"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00113.html">ReusableObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00079.html#a44d02451120483aa9b75635a48f78d92">getTimed</a> (<a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request a reusable object from the free list or mapped space. <a href="#a44d02451120483aa9b75635a48f78d92"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00079.html#ad4fc840525c7769cfd2c3f3a92dbf9f5">MappedReuse</a> (const char *name, size_t size, unsigned count)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a named memory segment for use with managed fixed size reusable objects. <a href="#ad4fc840525c7769cfd2c3f3a92dbf9f5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00079.html#a43557346c9e826707512da3409938484">removeLocked</a> (<a class="el" href="a00113.html">ReusableObject</a> *object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to return an object to the reuse pool when the mutex lock is already held. <a href="#a43557346c9e826707512da3409938484"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00113.html">ReusableObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00079.html#a57b47625b55a0b85f54549962ba16c5f">request</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request a reusable object from the free list or mapped space. <a href="#a57b47625b55a0b85f54549962ba16c5f"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf7260de0a2c4d0fa02aa6e56984fec3"></a><!-- doxytag: member="ucc::MappedReuse::create" ref="aaf7260de0a2c4d0fa02aa6e56984fec3" args="(const char *fname, unsigned count)" -->
void </td><td class="memItemRight" valign="bottom"><b>create</b> (const char *fname, unsigned count)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af1011f4e58272287a5a0c34db437b822"></a><!-- doxytag: member="ucc::MappedReuse::MappedReuse" ref="af1011f4e58272287a5a0c34db437b822" args="(size_t osize)" -->
</td><td class="memItemRight" valign="bottom"><b>MappedReuse</b> (size_t osize)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Map a reusable allocator over a named shared memory segment. </p>
<p>This may be used to form a resource bound fixed size managed heap in shared memory. The request can either be fullfilled from the object reuse pool or from a new section of memory, and if all memory in the segment has been exhausted, it can wait until more objects are returned by another thread to the reuse pool. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="a00196_source.html#l00184">184</a> of file <a class="el" href="a00196_source.html">mapped.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ad4fc840525c7769cfd2c3f3a92dbf9f5"></a><!-- doxytag: member="ucc::MappedReuse::MappedReuse" ref="ad4fc840525c7769cfd2c3f3a92dbf9f5" args="(const char *name, size_t size, unsigned count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::MappedReuse::MappedReuse </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>count</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a named memory segment for use with managed fixed size reusable objects. </p>
<p>The segment is created as writable. There is no read-only version of mapped reuse since the mapped segment can be read by another process directly as a mapped read-only vector. The actual mapped type will be derived from <a class="el" href="a00113.html" title="Reusable objects for forming private heaps.">ReusableObject</a> to meet the needs of the reusable allocator. The templated version should be used to assure type correctness rather than using this class directly. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of shared memory segment. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of the object type being mapped. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>of the maximum number of active mapped objects. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad5c846bc7688456dd2351547aed6539b"></a><!-- doxytag: member="ucc::MappedReuse::avail" ref="ad5c846bc7688456dd2351547aed6539b" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::MappedReuse::avail </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check whether there are objects available to be allocated. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if objects are available. </dd></dl>
</div>
</div>
<a class="anchor" id="a248272488eeaae52e13bc470854f0424"></a><!-- doxytag: member="ucc::MappedReuse::get" ref="a248272488eeaae52e13bc470854f0424" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00113.html">ReusableObject</a>* ucc::MappedReuse::get </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request a reusable object from the free list or mapped space. </p>
<p>This method blocks until an object becomes available. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>free object. </dd></dl>
<p>Reimplemented in <a class="el" href="a00076.html#a566b6a02f6d155b0ec209d613de23a79">ucc::mapped_reuse< T ></a>.</p>
</div>
</div>
<a class="anchor" id="aab398502f82432593fb03e51b57f3788"></a><!-- doxytag: member="ucc::MappedReuse::getLocked" ref="aab398502f82432593fb03e51b57f3788" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00113.html">ReusableObject</a>* ucc::MappedReuse::getLocked </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Used to get an object from the reuse pool when the mutex lock is already held. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>object from pool or NULL if exhausted. </dd></dl>
<p>Reimplemented in <a class="el" href="a00076.html#aea181320a0fa012f38e079a665aa3bc7">ucc::mapped_reuse< T ></a>.</p>
</div>
</div>
<a class="anchor" id="a44d02451120483aa9b75635a48f78d92"></a><!-- doxytag: member="ucc::MappedReuse::getTimed" ref="a44d02451120483aa9b75635a48f78d92" args="(timeout_t timeout)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00113.html">ReusableObject</a>* ucc::MappedReuse::getTimed </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>timeout</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request a reusable object from the free list or mapped space. </p>
<p>This method blocks until an object becomes available or the timeout has expired. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </td><td>to wait in milliseconds. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>free object or NULL if timeout. </dd></dl>
<p>Reimplemented in <a class="el" href="a00076.html#a1b56dd1f66a78a6590c2adc0168c38fc">ucc::mapped_reuse< T ></a>.</p>
</div>
</div>
<a class="anchor" id="a43557346c9e826707512da3409938484"></a><!-- doxytag: member="ucc::MappedReuse::removeLocked" ref="a43557346c9e826707512da3409938484" args="(ReusableObject *object)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::MappedReuse::removeLocked </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00113.html">ReusableObject</a> * </td>
<td class="paramname"> <em>object</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Used to return an object to the reuse pool when the mutex lock is already held. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>being returned. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a57b47625b55a0b85f54549962ba16c5f"></a><!-- doxytag: member="ucc::MappedReuse::request" ref="a57b47625b55a0b85f54549962ba16c5f" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00113.html">ReusableObject</a>* ucc::MappedReuse::request </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request a reusable object from the free list or mapped space. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>free object or NULL if pool is exhausted. </dd></dl>
<p>Reimplemented in <a class="el" href="a00076.html#a9a5ef2602129c869b2fedb47ffad72f7">ucc::mapped_reuse< T ></a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00196_source.html">mapped.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:34 2010 for UCommon by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
|