/usr/share/doc/libucommon-dev/a00088.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 | <!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::mutex_pointer< 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="a00088.html">mutex_pointer</a>
</div>
</div>
<div class="contents">
<h1>ucc::mutex_pointer< T > Class Template Reference</h1><!-- doxytag: class="ucc::mutex_pointer" --><!-- doxytag: inherits="ucc::auto_protect" -->
<p>Typed smart locked pointer class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00208_source.html">thread.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucc::mutex_pointer< T >:</div>
<div class="dynsection">
<div class="center"><img src="a00451.png" border="0" usemap="#ucc_1_1mutex__pointer_3_01_t_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1mutex__pointer_3_01_t_01_4_inherit__map" id="ucc_1_1mutex__pointer_3_01_t_01_4_inherit__map">
<area shape="rect" id="node2" href="a00030.html" title="A mutex locked object smart pointer helper class." alt="" coords="29,5,163,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::mutex_pointer< T >:</div>
<div class="dynsection">
<div class="center"><img src="a00452.png" border="0" usemap="#ucc_1_1mutex__pointer_3_01_t_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1mutex__pointer_3_01_t_01_4_coll__map" id="ucc_1_1mutex__pointer_3_01_t_01_4_coll__map">
<area shape="rect" id="node2" href="a00030.html" title="A mutex locked object smart pointer helper class." alt="" coords="29,5,163,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">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00088.html#a0df751dd82fdeade689596e925bfd8e7">get</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get pointer to object. <a href="#a0df751dd82fdeade689596e925bfd8e7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00088.html#a1f9c75ba861eeb3f6037e57037eeb53a">mutex_pointer</a> (T *object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a pointer with a reference to a heap object. <a href="#a1f9c75ba861eeb3f6037e57037eeb53a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad327e21ffab9132b4bb747abda026e52"></a><!-- doxytag: member="ucc::mutex_pointer::mutex_pointer" ref="ad327e21ffab9132b4bb747abda026e52" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00088.html#ad327e21ffab9132b4bb747abda026e52">mutex_pointer</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a pointer with no reference. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00088.html#a056d29e00d642997a1aeb56edd8aa883">operator*</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reference object we are pointing to through pointer indirection. <a href="#a056d29e00d642997a1aeb56edd8aa883"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00088.html#a02268f8f3c95d94c5656b1e2f46f1140">operator-></a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reference member of object we are pointing to. <a href="#a02268f8f3c95d94c5656b1e2f46f1140"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<class T><br/>
class ucc::mutex_pointer< T ></h3>
<p>Typed smart locked pointer class. </p>
<p>This is used to manage references to objects which are protected by an auto-generated mutex. The mutex is released when the pointer falls out of scope. </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="a00208_source.html#l02493">2493</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a1f9c75ba861eeb3f6037e57037eeb53a"></a><!-- doxytag: member="ucc::mutex_pointer::mutex_pointer" ref="a1f9c75ba861eeb3f6037e57037eeb53a" args="(T *object)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00088.html">ucc::mutex_pointer</a>< T >::<a class="el" href="a00088.html">mutex_pointer</a> </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>Create a pointer with a reference to a heap 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> </td><td>we are referencing. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00208_source.html#l02505">2505</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a0df751dd82fdeade689596e925bfd8e7"></a><!-- doxytag: member="ucc::mutex_pointer::get" ref="a0df751dd82fdeade689596e925bfd8e7" args="(void) const " -->
<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="a00088.html">ucc::mutex_pointer</a>< T >::get </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get pointer to object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer or NULL if we are not referencing an object. </dd></dl>
<p>Definition at line <a class="el" href="a00208_source.html#l02525">2525</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>
</div>
</div>
<a class="anchor" id="a056d29e00d642997a1aeb56edd8aa883"></a><!-- doxytag: member="ucc::mutex_pointer::operator*" ref="a056d29e00d642997a1aeb56edd8aa883" args="() const " -->
<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="a00088.html">ucc::mutex_pointer</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>Reference object we are pointing to through pointer indirection. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>object we are pointing to. </dd></dl>
<p>Definition at line <a class="el" href="a00208_source.html#l02511">2511</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>
</div>
</div>
<a class="anchor" id="a02268f8f3c95d94c5656b1e2f46f1140"></a><!-- doxytag: member="ucc::mutex_pointer::operator->" ref="a02268f8f3c95d94c5656b1e2f46f1140" args="() const " -->
<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="a00088.html">ucc::mutex_pointer</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>Reference member of object we are pointing to. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>reference to member of pointed object. </dd></dl>
<p>Definition at line <a class="el" href="a00208_source.html#l02518">2518</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:35 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>
|