/usr/share/doc/libucommon-dev/a00030.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 | <!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::auto_protect 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="a00030.html">auto_protect</a>
</div>
</div>
<div class="contents">
<h1>ucc::auto_protect Class Reference</h1><!-- doxytag: class="ucc::auto_protect" -->
<p>A mutex locked object smart pointer helper 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::auto_protect:</div>
<div class="dynsection">
<div class="center"><img src="a00361.png" border="0" usemap="#ucc_1_1auto__protect_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1auto__protect_inherit__map" id="ucc_1_1auto__protect_inherit__map">
<area shape="rect" id="node3" href="a00088.html" title="Typed smart locked pointer class." alt="" coords="5,83,187,112"/></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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00030.html#a941d83b135cb4ecfeb2b8c34d209a92c">auto_protect</a> (void *object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a protected pointer referencing an existing object. <a href="#a941d83b135cb4ecfeb2b8c34d209a92c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00030.html#a025d67ae1feac04b5262f9dc6b46bd7a">operator bool</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if the pointer is referencing an object. <a href="#a025d67ae1feac04b5262f9dc6b46bd7a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00030.html#adce561f4efcc101fe00521b04fb80b18">operator!</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if the pointer is not set. <a href="#adce561f4efcc101fe00521b04fb80b18"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00030.html#a80dc93daa92a3e6b6d289032adb64808">operator=</a> (void *object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set our pointer to a specific object. <a href="#a80dc93daa92a3e6b6d289032adb64808"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00030.html#af1cd68c6da064681e2b0d6529f55bf9c">release</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Manually release the pointer. <a href="#af1cd68c6da064681e2b0d6529f55bf9c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00030.html#a4f2e118e111ec36d8f35a3d052ebebd6">~auto_protect</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete protected pointer. <a href="#a4f2e118e111ec36d8f35a3d052ebebd6"></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="a87bda0ea90d8c6c578b4a01b5770eb59"></a><!-- doxytag: member="ucc::auto_protect::object" ref="a87bda0ea90d8c6c578b4a01b5770eb59" args="" -->
void * </td><td class="memItemRight" valign="bottom"><b>object</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A mutex locked object smart pointer helper class. </p>
<p>This is particularly useful in referencing objects which will be protected by the mutex protect function. When the pointer falls out of scope, the protecting mutex is also released. This is meant to be used by the typed <a class="el" href="a00088.html" title="Typed smart locked pointer class.">mutex_pointer</a> template. </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#l01273">1273</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a941d83b135cb4ecfeb2b8c34d209a92c"></a><!-- doxytag: member="ucc::auto_protect::auto_protect" ref="a941d83b135cb4ecfeb2b8c34d209a92c" args="(void *object)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::auto_protect::auto_protect </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>object</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a protected pointer referencing an existing 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 point to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a4f2e118e111ec36d8f35a3d052ebebd6"></a><!-- doxytag: member="ucc::auto_protect::~auto_protect" ref="a4f2e118e111ec36d8f35a3d052ebebd6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::auto_protect::~auto_protect </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Delete protected pointer. </p>
<p>When it falls out of scope the associated mutex is released. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a025d67ae1feac04b5262f9dc6b46bd7a"></a><!-- doxytag: member="ucc::auto_protect::operator bool" ref="a025d67ae1feac04b5262f9dc6b46bd7a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::auto_protect::operator bool </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Test if the pointer is referencing an object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the pointer is currently referencing an object. </dd></dl>
<p>Definition at line <a class="el" href="a00208_source.html#l01313">1313</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>
</div>
</div>
<a class="anchor" id="adce561f4efcc101fe00521b04fb80b18"></a><!-- doxytag: member="ucc::auto_protect::operator!" ref="adce561f4efcc101fe00521b04fb80b18" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::auto_protect::operator! </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Test if the pointer is not set. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the pointer is not referencing anything. </dd></dl>
<p>Definition at line <a class="el" href="a00208_source.html#l01306">1306</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>
</div>
</div>
<a class="anchor" id="a80dc93daa92a3e6b6d289032adb64808"></a><!-- doxytag: member="ucc::auto_protect::operator=" ref="a80dc93daa92a3e6b6d289032adb64808" args="(void *object)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::auto_protect::operator= </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>object</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set our pointer to a specific object. </p>
<p>If the pointer currently references another object, the associated mutex is released. The pointer references our new object and that new object is locked. </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>to assign to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af1cd68c6da064681e2b0d6529f55bf9c"></a><!-- doxytag: member="ucc::auto_protect::release" ref="af1cd68c6da064681e2b0d6529f55bf9c" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::auto_protect::release </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Manually release the pointer. </p>
<p>This releases the mutex. </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:25 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>
|