/usr/share/doc/libucommon-dev/a00043.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 | <!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::CountedObject 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="a00043.html">CountedObject</a>
</div>
</div>
<div class="contents">
<h1>ucc::CountedObject Class Reference</h1><!-- doxytag: class="ucc::CountedObject" --><!-- doxytag: inherits="ucc::Object" -->
<p>A base class for reference counted objects.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00199_source.html">object.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucc::CountedObject:</div>
<div class="dynsection">
<div class="center"><img src="a00377.png" border="0" usemap="#ucc_1_1_counted_object_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1_counted_object_inherit__map" id="ucc_1_1_counted_object_inherit__map">
<area shape="rect" id="node5" href="a00103.html" title="This is a base class for objects that may be created in pager pools." alt="" coords="5,160,133,189"/><area shape="rect" id="node7" href="a00119.html" title="Compiled script container." alt="" coords="157,160,243,189"/><area shape="rect" id="node9" href="a00158.html" title="This is an internal class which contains the actual string data along with some control..." alt="" coords="267,160,405,189"/><area shape="rect" id="node2" href="a00093.html" title="A common base class for all managed objects." alt="" coords="153,5,247,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucc::CountedObject:</div>
<div class="dynsection">
<div class="center"><img src="a00378.png" border="0" usemap="#ucc_1_1_counted_object_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1_counted_object_coll__map" id="ucc_1_1_counted_object_coll__map">
<area shape="rect" id="node2" href="a00093.html" title="A common base class for all managed objects." alt="" coords="32,5,125,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>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00043.html#a9ef9b7893de764fe0fd4852448b55eda">copied</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of active references (retentions) to our object. <a href="#a9ef9b7893de764fe0fd4852448b55eda"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00043.html#a6713d16ac91ca4b2c1f40fd6e6a9b83f">isCopied</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if the object has copied references. <a href="#a6713d16ac91ca4b2c1f40fd6e6a9b83f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00043.html#aa2f6d15eea437d5a8f7ed3d8d46f770e">isRetained</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if the object has been referenced (retained) by anyone yet. <a href="#aa2f6d15eea437d5a8f7ed3d8d46f770e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00043.html#a682422b0a164087fb29452d1e5011438">release</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decrease reference count when released. <a href="#a682422b0a164087fb29452d1e5011438"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad09aabb51a3fa9d298db45849167ad8a"></a><!-- doxytag: member="ucc::CountedObject::retain" ref="ad09aabb51a3fa9d298db45849167ad8a" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00043.html#ad09aabb51a3fa9d298db45849167ad8a">retain</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Increase reference count when retained. <br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00043.html#a60868d902868df24a26cf6ba2998b68f">CountedObject</a> (const <a class="el" href="a00093.html">Object</a> &ref)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a copy of a counted object. <a href="#a60868d902868df24a26cf6ba2998b68f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a726070dd9b9caf58eefee2f1a580a449"></a><!-- doxytag: member="ucc::CountedObject::CountedObject" ref="a726070dd9b9caf58eefee2f1a580a449" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00043.html#a726070dd9b9caf58eefee2f1a580a449">CountedObject</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a counted object, mark initially as unreferenced. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00043.html#a52cc516039b28a17b2f59cdec577c9c6">dealloc</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Dealloc object no longer referenced. <a href="#a52cc516039b28a17b2f59cdec577c9c6"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A base class for reference counted objects. </p>
<p>Reference counted objects keep track of how many objects refer to them and fall out of scope when they are no longer being referred to. This can be used to achieve automatic heap management when used in conjunction with smart pointers. </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="a00199_source.html#l00090">90</a> of file <a class="el" href="a00199_source.html">object.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a60868d902868df24a26cf6ba2998b68f"></a><!-- doxytag: member="ucc::CountedObject::CountedObject" ref="a60868d902868df24a26cf6ba2998b68f" args="(const Object &ref)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::CountedObject::CountedObject </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00093.html">Object</a> & </td>
<td class="paramname"> <em>ref</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a copy of a counted object. </p>
<p>Our instance is not a reference to the original object but a duplicate, so we do not retain the original and we do reset our count to mark as initially unreferenced. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a9ef9b7893de764fe0fd4852448b55eda"></a><!-- doxytag: member="ucc::CountedObject::copied" ref="a9ef9b7893de764fe0fd4852448b55eda" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned ucc::CountedObject::copied </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>Return the number of active references (retentions) to our object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of references to our object. </dd></dl>
<p>Definition at line <a class="el" href="a00199_source.html#l00136">136</a> of file <a class="el" href="a00199_source.html">object.h</a>.</p>
</div>
</div>
<a class="anchor" id="a52cc516039b28a17b2f59cdec577c9c6"></a><!-- doxytag: member="ucc::CountedObject::dealloc" ref="a52cc516039b28a17b2f59cdec577c9c6" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ucc::CountedObject::dealloc </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Dealloc object no longer referenced. </p>
<p>The dealloc routine would commonly be used for a self delete to return the object back to a heap when it is no longer referenced. </p>
<p>Reimplemented in <a class="el" href="a00103.html#a17c7e061814cd9f6bb17264feead356b">ucc::PagerObject</a>.</p>
</div>
</div>
<a class="anchor" id="a6713d16ac91ca4b2c1f40fd6e6a9b83f"></a><!-- doxytag: member="ucc::CountedObject::isCopied" ref="a6713d16ac91ca4b2c1f40fd6e6a9b83f" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::CountedObject::isCopied </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>Test if the object has copied references. </p>
<p>This means that more than one object has a reference to our object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if referenced by more than one object. </dd></dl>
<p>Definition at line <a class="el" href="a00199_source.html#l00122">122</a> of file <a class="el" href="a00199_source.html">object.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa2f6d15eea437d5a8f7ed3d8d46f770e"></a><!-- doxytag: member="ucc::CountedObject::isRetained" ref="aa2f6d15eea437d5a8f7ed3d8d46f770e" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::CountedObject::isRetained </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>Test if the object has been referenced (retained) by anyone yet. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if retained. </dd></dl>
<p>Definition at line <a class="el" href="a00199_source.html#l00129">129</a> of file <a class="el" href="a00199_source.html">object.h</a>.</p>
</div>
</div>
<a class="anchor" id="a682422b0a164087fb29452d1e5011438"></a><!-- doxytag: member="ucc::CountedObject::release" ref="a682422b0a164087fb29452d1e5011438" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::CountedObject::release </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Decrease reference count when released. </p>
<p>If no longer retained, then the object is dealloc'd. </p>
<p>Reimplemented from <a class="el" href="a00093.html#abe05f81356bdc73e67df7fb8a0ec59d5">ucc::Object</a>.</p>
<p>Reimplemented in <a class="el" href="a00103.html#af77f080747ffc13e6a1314c2f3b69c46">ucc::PagerObject</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00199_source.html">object.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:28 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>
|