This file is indexed.

/usr/share/doc/libucommon-dev/a00112.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
<!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::ReusableAllocator 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&nbsp;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&nbsp;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&nbsp;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&nbsp;Structure&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="a00214.html">ucc</a>::<a class="el" href="a00112.html">ReusableAllocator</a>
  </div>
</div>
<div class="contents">
<h1>ucc::ReusableAllocator Class Reference</h1><!-- doxytag: class="ucc::ReusableAllocator" --><!-- doxytag: inherits="ucc::Conditional" -->
<p>Class for resource bound memory pools between threads.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00208_source.html">thread.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ucc::ReusableAllocator:</div>
<div class="dynsection">
<div class="center"><img src="a00487.png" border="0" usemap="#ucc_1_1_reusable_allocator_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1_reusable_allocator_inherit__map" id="ucc_1_1_reusable_allocator_inherit__map">
<area shape="rect" id="node5" href="a00018.html" title="An array of reusable objects." alt="" coords="48,160,171,189"/><area shape="rect" id="node9" href="a00079.html" title="Map a reusable allocator over a named shared memory segment." alt="" coords="216,160,357,189"/><area shape="rect" id="node13" href="a00105.html" title="A mempager source of reusable objects." alt="" coords="403,160,528,189"/><area shape="rect" id="node2" href="a00040.html" title="The conditional is a common base for other thread synchronizing classes." alt="" coords="225,5,348,35"/><area shape="rect" id="node7" href="a00017.html" title="An array of reusable types." alt="" coords="5,237,171,267"/><area shape="rect" id="node11" href="a00076.html" title="Template class to map typed resusble objects into shared memory heap." alt="" coords="195,237,379,267"/><area shape="rect" id="node15" href="a00101.html" title="A reusable private pool of reusable types." alt="" coords="403,237,573,267"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucc::ReusableAllocator:</div>
<div class="dynsection">
<div class="center"><img src="a00488.png" border="0" usemap="#ucc_1_1_reusable_allocator_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1_reusable_allocator_coll__map" id="ucc_1_1_reusable_allocator_coll__map">
<area shape="rect" id="node2" 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="node4" href="a00113.html" title="Reusable objects for forming private heaps." alt="" coords="152,187,301,216"/><area shape="rect" id="node6" 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="node8" href="a00093.html" title="A common base class for all managed objects." alt="" coords="180,5,273,35"/></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>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00113.html">ReusableObject</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00112.html#a9b4b548990e2c6a0c1e99b71cafdb94a">next</a> (<a class="el" href="a00113.html">ReusableObject</a> *object)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get next reusable object in the pool.  <a href="#a9b4b548990e2c6a0c1e99b71cafdb94a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00112.html#a5b05f8b1e05f484720b246d06505d809">release</a> (<a class="el" href="a00113.html">ReusableObject</a> *object)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Release resuable object.  <a href="#a5b05f8b1e05f484720b246d06505d809"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00112.html#a91bc1b0f48040036d0dbf3c477834688">ReusableAllocator</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize reusable allocator through a conditional.  <a href="#a91bc1b0f48040036d0dbf3c477834688"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a604ead1240097f60c0fb6049a734560c"></a><!-- doxytag: member="ucc::ReusableAllocator::freelist" ref="a604ead1240097f60c0fb6049a734560c" args="" -->
<a class="el" href="a00113.html">ReusableObject</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>freelist</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2bd1af9d7bb26478800c95ac70506c68"></a><!-- doxytag: member="ucc::ReusableAllocator::waiting" ref="a2bd1af9d7bb26478800c95ac70506c68" args="" -->
unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><b>waiting</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Class for resource bound memory pools between threads. </p>
<p>This is used to support a memory pool allocation scheme where a pool of reusable objects may be allocated, and the pool renewed by releasing objects or back. When the pool is used up, a pool consuming thread then must wait for a resource to be freed by another consumer (or timeout). This class is not meant to be used directly, but rather to build the synchronizing control between consumers which might be forced to wait for a resource. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar &lt;<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>&gt; </dd></dl>

<p>Definition at line <a class="el" href="a00208_source.html#l00756">756</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a91bc1b0f48040036d0dbf3c477834688"></a><!-- doxytag: member="ucc::ReusableAllocator::ReusableAllocator" ref="a91bc1b0f48040036d0dbf3c477834688" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ucc::ReusableAllocator::ReusableAllocator </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Initialize reusable allocator through a conditional. </p>
<p>Zero free list. </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a9b4b548990e2c6a0c1e99b71cafdb94a"></a><!-- doxytag: member="ucc::ReusableAllocator::next" ref="a9b4b548990e2c6a0c1e99b71cafdb94a" args="(ReusableObject *object)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00113.html">ReusableObject</a>* ucc::ReusableAllocator::next </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00113.html">ReusableObject</a> *&nbsp;</td>
          <td class="paramname"> <em>object</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get next reusable object in the 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>&nbsp;</td><td>from list. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>next object. </dd></dl>

<p>Definition at line <a class="el" href="a00208_source.html#l00772">772</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>

</div>
</div>
<a class="anchor" id="a5b05f8b1e05f484720b246d06505d809"></a><!-- doxytag: member="ucc::ReusableAllocator::release" ref="a5b05f8b1e05f484720b246d06505d809" args="(ReusableObject *object)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ucc::ReusableAllocator::release </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00113.html">ReusableObject</a> *&nbsp;</td>
          <td class="paramname"> <em>object</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Release resuable object. </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>&nbsp;</td><td>being released. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00208_source.html">thread.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:40 2010 for UCommon by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>