/usr/share/doc/libucommon-dev/a00076.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 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 | <!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::mapped_reuse< T > Class Template 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="a00076.html">mapped_reuse</a>
</div>
</div>
<div class="contents">
<h1>ucc::mapped_reuse< T > Class Template Reference</h1><!-- doxytag: class="ucc::mapped_reuse" --><!-- doxytag: inherits="ucc::MappedReuse" -->
<p>Template class to map typed resusble objects into shared memory heap.
<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::mapped_reuse< T >:</div>
<div class="dynsection">
<div class="center"><img src="a00431.png" border="0" usemap="#ucc_1_1mapped__reuse_3_01_t_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1mapped__reuse_3_01_t_01_4_inherit__map" id="ucc_1_1mapped__reuse_3_01_t_01_4_inherit__map">
<area shape="rect" id="node2" href="a00079.html" title="Map a reusable allocator over a named shared memory segment." alt="" coords="109,160,251,189"/><area shape="rect" id="node4" href="a00112.html" title="Class for resource bound memory pools between threads." alt="" coords="5,83,171,112"/><area shape="rect" id="node6" 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="node8" 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::mapped_reuse< T >:</div>
<div class="dynsection">
<div class="center"><img src="a00432.png" border="0" usemap="#ucc_1_1mapped__reuse_3_01_t_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1mapped__reuse_3_01_t_01_4_coll__map" id="ucc_1_1mapped__reuse_3_01_t_01_4_coll__map">
<area shape="rect" id="node2" href="a00079.html" title="Map a reusable allocator over a named shared memory segment." alt="" coords="231,379,372,408"/><area shape="rect" id="node4" href="a00112.html" title="Class for resource bound memory pools between threads." alt="" coords="35,283,200,312"/><area shape="rect" id="node6" 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="node8" href="a00113.html" title="Reusable objects for forming private heaps." alt="" coords="152,187,301,216"/><area shape="rect" id="node10" 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="node12" href="a00093.html" title="A common base class for all managed objects." alt="" coords="180,5,273,35"/><area shape="rect" id="node15" href="a00078.html" title="Construct or access a named section of memory." alt="" coords="224,283,379,312"/><area shape="rect" id="node17" href="a00086.html" title="Generic non-recursive exclusive lock class." alt="" coords="403,283,496,312"/><area shape="rect" id="node19" 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">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00076.html#a566b6a02f6d155b0ec209d613de23a79">get</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request a typed reusable object from the free list or mapped space. <a href="#a566b6a02f6d155b0ec209d613de23a79"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00076.html#aea181320a0fa012f38e079a665aa3bc7">getLocked</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to get a typed object from the reuse pool when the mutex lock is already held. <a href="#aea181320a0fa012f38e079a665aa3bc7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00076.html#a1b56dd1f66a78a6590c2adc0168c38fc">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 typed reusable object from the free list or mapped space. <a href="#a1b56dd1f66a78a6590c2adc0168c38fc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00076.html#aff94a6c4b95f4d97b0bc3f8679f27cee">initialize</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize typed data in mapped array. <a href="#aff94a6c4b95f4d97b0bc3f8679f27cee"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00076.html#a4a633d6ed75c43bac837a0b43e892378">mapped_reuse</a> (const char *name, unsigned number)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct mapped reuse array of typed objects. <a href="#a4a633d6ed75c43bac837a0b43e892378"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00076.html#a0f97fd1654b110132c5d7b88fd3d1475">operator bool</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check whether there are typed objects available to be allocated. <a href="#a0f97fd1654b110132c5d7b88fd3d1475"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00076.html#a1cf523f20120b1cbdebdebf9452d249a">operator T *</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request a typed reusable object from the free list or mapped space. <a href="#a1cf523f20120b1cbdebdebf9452d249a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00076.html#a718e2aaca553791a031fbe9acb72050f">operator!</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check whether there are typed objects available to be allocated. <a href="#a718e2aaca553791a031fbe9acb72050f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00076.html#ac555906df4cef847ac1143863ebddf65">operator*</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request a typed reusable object from the free list or mapped space by pointer reference. <a href="#ac555906df4cef847ac1143863ebddf65"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00076.html#a9998f7f5600d29b831e11ffbea8a440a">pos</a> (size_t member)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get typed object from a specific member offset within the mapped segment. <a href="#a9998f7f5600d29b831e11ffbea8a440a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00076.html#a7ded62fa149b1951b1f45b6aec7284f8">release</a> (T *object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to release a typed object back to the reuse typed object pool. <a href="#a7ded62fa149b1951b1f45b6aec7284f8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00076.html#a6bc03d14ae61bcf37bfb79647c7a4812">removeLocked</a> (T *object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to return a typed object to the reuse pool when the mutex lock is already held. <a href="#a6bc03d14ae61bcf37bfb79647c7a4812"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00076.html#a9a5ef2602129c869b2fedb47ffad72f7">request</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request a typed reusable object from the free list or mapped space. <a href="#a9a5ef2602129c869b2fedb47ffad72f7"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<class T><br/>
class ucc::mapped_reuse< T ></h3>
<p>Template class to map typed resusble objects into shared memory heap. </p>
<p>This is used to construct a read/write heap of objects that are held in a named shared memory segment. Member objects are allocated from a reusable heap but are stored in the shared memory segment as a vector. </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#l00335">335</a> of file <a class="el" href="a00196_source.html">mapped.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a4a633d6ed75c43bac837a0b43e892378"></a><!-- doxytag: member="ucc::mapped_reuse::mapped_reuse" ref="a4a633d6ed75c43bac837a0b43e892378" args="(const char *name, unsigned number)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00076.html">ucc::mapped_reuse</a>< T >::<a class="el" href="a00076.html">mapped_reuse</a> </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">unsigned </td>
<td class="paramname"> <em>number</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct mapped reuse array of typed objects. </p>
<p>This is constructed for read/write access. <a class="el" href="a00077.html" title="Class to access a named mapped segment published from another process.">mapped_view</a> is used in all cases for read-only access to mapped data. </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 mapped segment to construct. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>number</em> </td><td>of objects in the mapped vector. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00196_source.html#l00349">349</a> of file <a class="el" href="a00196_source.html">mapped.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a566b6a02f6d155b0ec209d613de23a79"></a><!-- doxytag: member="ucc::mapped_reuse::get" ref="a566b6a02f6d155b0ec209d613de23a79" args="(void)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">T* <a class="el" href="a00076.html">ucc::mapped_reuse</a>< T >::get </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request a typed 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 typed object. </dd></dl>
<p>Reimplemented from <a class="el" href="a00079.html#a248272488eeaae52e13bc470854f0424">ucc::MappedReuse</a>.</p>
<p>Definition at line <a class="el" href="a00196_source.html#l00402">402</a> of file <a class="el" href="a00196_source.html">mapped.h</a>.</p>
</div>
</div>
<a class="anchor" id="aea181320a0fa012f38e079a665aa3bc7"></a><!-- doxytag: member="ucc::mapped_reuse::getLocked" ref="aea181320a0fa012f38e079a665aa3bc7" args="(void)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">T* <a class="el" href="a00076.html">ucc::mapped_reuse</a>< T >::getLocked </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Used to get a typed object from the reuse pool when the mutex lock is already held. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>typed object from pool or NULL if exhausted. </dd></dl>
<p>Reimplemented from <a class="el" href="a00079.html#aab398502f82432593fb03e51b57f3788">ucc::MappedReuse</a>.</p>
<p>Definition at line <a class="el" href="a00196_source.html#l00436">436</a> of file <a class="el" href="a00196_source.html">mapped.h</a>.</p>
</div>
</div>
<a class="anchor" id="a1b56dd1f66a78a6590c2adc0168c38fc"></a><!-- doxytag: member="ucc::mapped_reuse::getTimed" ref="a1b56dd1f66a78a6590c2adc0168c38fc" args="(timeout_t timeout)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">T* <a class="el" href="a00076.html">ucc::mapped_reuse</a>< T >::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><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request a typed reusable object from the free list or mapped space. </p>
<p>This method blocks until an object becomes available from another thread or the timeout expires. </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>in milliseconds. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>free typed object. </dd></dl>
<p>Reimplemented from <a class="el" href="a00079.html#a44d02451120483aa9b75635a48f78d92">ucc::MappedReuse</a>.</p>
<p>Definition at line <a class="el" href="a00196_source.html#l00412">412</a> of file <a class="el" href="a00196_source.html">mapped.h</a>.</p>
</div>
</div>
<a class="anchor" id="aff94a6c4b95f4d97b0bc3f8679f27cee"></a><!-- doxytag: member="ucc::mapped_reuse::initialize" ref="aff94a6c4b95f4d97b0bc3f8679f27cee" args="(void)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00076.html">ucc::mapped_reuse</a>< T >::initialize </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initialize typed data in mapped array. </p>
<p>Assumes default constructor for type. </p>
<p>Definition at line <a class="el" href="a00196_source.html#l00356">356</a> of file <a class="el" href="a00196_source.html">mapped.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0f97fd1654b110132c5d7b88fd3d1475"></a><!-- doxytag: member="ucc::mapped_reuse::operator bool" ref="a0f97fd1654b110132c5d7b88fd3d1475" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00076.html">ucc::mapped_reuse</a>< T >::operator bool </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check whether there are typed objects available to be allocated. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if objects are available. </dd></dl>
<p>Reimplemented from <a class="el" href="a00078.html#a75f74b77dbe138bef90e253a339328ef">ucc::MappedMemory</a>.</p>
<p>Definition at line <a class="el" href="a00196_source.html#l00363">363</a> of file <a class="el" href="a00196_source.html">mapped.h</a>.</p>
</div>
</div>
<a class="anchor" id="a1cf523f20120b1cbdebdebf9452d249a"></a><!-- doxytag: member="ucc::mapped_reuse::operator T *" ref="a1cf523f20120b1cbdebdebf9452d249a" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00076.html">ucc::mapped_reuse</a>< T >::operator T * </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request a typed 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>Definition at line <a class="el" href="a00196_source.html#l00378">378</a> of file <a class="el" href="a00196_source.html">mapped.h</a>.</p>
</div>
</div>
<a class="anchor" id="a718e2aaca553791a031fbe9acb72050f"></a><!-- doxytag: member="ucc::mapped_reuse::operator!" ref="a718e2aaca553791a031fbe9acb72050f" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="a00076.html">ucc::mapped_reuse</a>< T >::operator! </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check whether there are typed objects available to be allocated. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if no more typed objects are available. </dd></dl>
<p>Reimplemented from <a class="el" href="a00078.html#a27b3986e3831ff3c9c1672f6c3299349">ucc::MappedMemory</a>.</p>
<p>Definition at line <a class="el" href="a00196_source.html#l00370">370</a> of file <a class="el" href="a00196_source.html">mapped.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac555906df4cef847ac1143863ebddf65"></a><!-- doxytag: member="ucc::mapped_reuse::operator*" ref="ac555906df4cef847ac1143863ebddf65" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">T* <a class="el" href="a00076.html">ucc::mapped_reuse</a>< T >::operator* </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request a typed reusable object from the free list or mapped space by pointer reference. </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>Definition at line <a class="el" href="a00196_source.html#l00386">386</a> of file <a class="el" href="a00196_source.html">mapped.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9998f7f5600d29b831e11ffbea8a440a"></a><!-- doxytag: member="ucc::mapped_reuse::pos" ref="a9998f7f5600d29b831e11ffbea8a440a" args="(size_t member)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">T* <a class="el" href="a00076.html">ucc::mapped_reuse</a>< T >::pos </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>member</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get typed object from a specific member offset within the mapped segment. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>member</em> </td><td>offset from start of segment. Will fault if past end. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>typed object pointer. </dd></dl>
<p>Definition at line <a class="el" href="a00196_source.html#l00394">394</a> of file <a class="el" href="a00196_source.html">mapped.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7ded62fa149b1951b1f45b6aec7284f8"></a><!-- doxytag: member="ucc::mapped_reuse::release" ref="a7ded62fa149b1951b1f45b6aec7284f8" args="(T *object)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00076.html">ucc::mapped_reuse</a>< T >::release </td>
<td>(</td>
<td class="paramtype">T * </td>
<td class="paramname"> <em>object</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Used to release a typed object back to the reuse typed object pool. </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 released. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00196_source.html#l00443">443</a> of file <a class="el" href="a00196_source.html">mapped.h</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
<div class="center"><img src="a00076_a7ded62fa149b1951b1f45b6aec7284f8_cgraph.png" border="0" usemap="#a00076_a7ded62fa149b1951b1f45b6aec7284f8_cgraph_map" alt=""></div>
<map name="a00076_a7ded62fa149b1951b1f45b6aec7284f8_cgraph_map" id="a00076_a7ded62fa149b1951b1f45b6aec7284f8_cgraph">
<area shape="rect" id="node3" href="a00214.html#ab7bef2898e731474a9c3dfa805a6f56d" title="Convenience function to unlock shared object through it's protocol." alt="" coords="256,5,355,35"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a6bc03d14ae61bcf37bfb79647c7a4812"></a><!-- doxytag: member="ucc::mapped_reuse::removeLocked" ref="a6bc03d14ae61bcf37bfb79647c7a4812" args="(T *object)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00076.html">ucc::mapped_reuse</a>< T >::removeLocked </td>
<td>(</td>
<td class="paramtype">T * </td>
<td class="paramname"> <em>object</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Used to return a typed 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>
<p>Definition at line <a class="el" href="a00196_source.html#l00428">428</a> of file <a class="el" href="a00196_source.html">mapped.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9a5ef2602129c869b2fedb47ffad72f7"></a><!-- doxytag: member="ucc::mapped_reuse::request" ref="a9a5ef2602129c869b2fedb47ffad72f7" args="(void)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">T* <a class="el" href="a00076.html">ucc::mapped_reuse</a>< T >::request </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request a typed reusable object from the free list or mapped space. </p>
<p>This method does not block or wait. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>free typed object if available or NULL. </dd></dl>
<p>Reimplemented from <a class="el" href="a00079.html#a57b47625b55a0b85f54549962ba16c5f">ucc::MappedReuse</a>.</p>
<p>Definition at line <a class="el" href="a00196_source.html#l00420">420</a> of file <a class="el" href="a00196_source.html">mapped.h</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:33 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>
|