This file is indexed.

/usr/share/doc/libucommon-dev/a00138.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
<!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::shared_pointer&lt; T &gt; 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&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="a00138.html">shared_pointer</a>
  </div>
</div>
<div class="contents">
<h1>ucc::shared_pointer&lt; T &gt; Class Template Reference</h1><!-- doxytag: class="ucc::shared_pointer" --><!-- doxytag: inherits="ucc::SharedPointer" -->
<p>Templated shared pointer for singleton shared objects of specific type.  
<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::shared_pointer&lt; T &gt;:</div>
<div class="dynsection">
<div class="center"><img src="a00527.png" border="0" usemap="#ucc_1_1shared__pointer_3_01_t_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1shared__pointer_3_01_t_01_4_inherit__map" id="ucc_1_1shared__pointer_3_01_t_01_4_inherit__map">
<area shape="rect" id="node2" href="a00141.html" title="The shared pointer is used to manage a singleton instance of shared object." alt="" coords="27,160,168,189"/><area shape="rect" id="node4" href="a00041.html" title="The conditional rw seperates scheduling for optizming behavior or rw locks." alt="" coords="13,83,181,112"/><area shape="rect" id="node6" href="a00040.html" title="The conditional is a common base for other thread synchronizing classes." alt="" coords="36,5,159,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::shared_pointer&lt; T &gt;:</div>
<div class="dynsection">
<div class="center"><img src="a00528.png" border="0" usemap="#ucc_1_1shared__pointer_3_01_t_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1shared__pointer_3_01_t_01_4_coll__map" id="ucc_1_1shared__pointer_3_01_t_01_4_coll__map">
<area shape="rect" id="node2" href="a00141.html" title="The shared pointer is used to manage a singleton instance of shared object." alt="" coords="151,181,292,211"/><area shape="rect" id="node4" href="a00041.html" title="The conditional rw seperates scheduling for optizming behavior or rw locks." alt="" coords="5,85,173,115"/><area shape="rect" id="node6" href="a00040.html" title="The conditional is a common base for other thread synchronizing classes." alt="" coords="28,5,151,35"/><area shape="rect" id="node8" href="a00140.html" title="Shared singleton object." alt="" coords="197,85,336,115"/></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">const T *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00138.html#a61ff23d5ebe77aae4cb275a8953c9b5e">dup</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Acquire a shared (duplocate) reference to the typed singleton object.  <a href="#a61ff23d5ebe77aae4cb275a8953c9b5e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00138.html#a8cb97caf54d052dbc4c2a7b64537d60f">operator*</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Access shared lock typed singleton object by pointer reference.  <a href="#a8cb97caf54d052dbc4c2a7b64537d60f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00138.html#a4d22e05dc137c36f9f4462b866aa63e5">operator=</a> (T *object)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Replace existing typed singleton object through assignment.  <a href="#a4d22e05dc137c36f9f4462b866aa63e5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00138.html#a358c1bcfde7cebafe247dcc3bdae6f50">replace</a> (T *object)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Replace existing typed singleton instance with new one.  <a href="#a358c1bcfde7cebafe247dcc3bdae6f50"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0e20901293c53ce070a8a73c8bc9a97e"></a><!-- doxytag: member="ucc::shared_pointer::shared_pointer" ref="a0e20901293c53ce070a8a73c8bc9a97e" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00138.html#a0e20901293c53ce070a8a73c8bc9a97e">shared_pointer</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Created shared locking for typed singleton pointer. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class T&gt;<br/>
 class ucc::shared_pointer&lt; T &gt;</h3>

<p>Templated shared pointer for singleton shared objects of specific type. </p>
<p>This is used as typed template for the <a class="el" href="a00141.html" title="The shared pointer is used to manage a singleton instance of shared object.">SharedPointer</a> object reference management class. This is used to supply a typed singleton shared instance to the typed <a class="el" href="a00136.html" title="A templated smart pointer instance for shared singleton typed objects.">shared_instance</a> template class. </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#l02313">2313</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a61ff23d5ebe77aae4cb275a8953c9b5e"></a><!-- doxytag: member="ucc::shared_pointer::dup" ref="a61ff23d5ebe77aae4cb275a8953c9b5e" args="(void)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">const T* <a class="el" href="a00138.html">ucc::shared_pointer</a>&lt; T &gt;::dup </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Acquire a shared (duplocate) reference to the typed singleton object. </p>
<p>This is a form of shared access lock. Derived classes and templates access conditionallock "release" when the shared pointer is no longer needed. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>typed shared object. </dd></dl>

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

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
<div class="center"><img src="a00138_a61ff23d5ebe77aae4cb275a8953c9b5e_cgraph.png" border="0" usemap="#a00138_a61ff23d5ebe77aae4cb275a8953c9b5e_cgraph_map" alt=""></div>
<map name="a00138_a61ff23d5ebe77aae4cb275a8953c9b5e_cgraph_map" id="a00138_a61ff23d5ebe77aae4cb275a8953c9b5e_cgraph">
<area shape="rect" id="node3" href="a00214.html#a5ece1dc7970bcebf162c214d349292b2" title="Convenience function to restore shared locking for object through it&#39;s protocol..." alt="" coords="235,5,323,35"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="a8cb97caf54d052dbc4c2a7b64537d60f"></a><!-- doxytag: member="ucc::shared_pointer::operator*" ref="a8cb97caf54d052dbc4c2a7b64537d60f" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">T* <a class="el" href="a00138.html">ucc::shared_pointer</a>&lt; T &gt;::operator* </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Access shared lock typed singleton object by pointer reference. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>typed shared object. </dd></dl>

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

</div>
</div>
<a class="anchor" id="a4d22e05dc137c36f9f4462b866aa63e5"></a><!-- doxytag: member="ucc::shared_pointer::operator=" ref="a4d22e05dc137c36f9f4462b866aa63e5" args="(T *object)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="a00138.html">ucc::shared_pointer</a>&lt; T &gt;::operator= </td>
          <td>(</td>
          <td class="paramtype">T *&nbsp;</td>
          <td class="paramname"> <em>object</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Replace existing typed singleton object through assignment. </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>to assign. </td></tr>
  </table>
  </dd>
</dl>

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

</div>
</div>
<a class="anchor" id="a358c1bcfde7cebafe247dcc3bdae6f50"></a><!-- doxytag: member="ucc::shared_pointer::replace" ref="a358c1bcfde7cebafe247dcc3bdae6f50" args="(T *object)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="a00138.html">ucc::shared_pointer</a>&lt; T &gt;::replace </td>
          <td>(</td>
          <td class="paramtype">T *&nbsp;</td>
          <td class="paramname"> <em>object</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Replace existing typed singleton instance with new one. </p>
<p>This happens during exclusive locking, and the commit method of the typed object will be called. </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 set. </td></tr>
  </table>
  </dd>
</dl>

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

</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:45 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>