/usr/share/doc/libucommon-dev/a00114.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 | <!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::rexlock 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="a00114.html">rexlock</a>
</div>
</div>
<div class="contents">
<h1>ucc::rexlock Class Reference</h1><!-- doxytag: class="ucc::rexlock" --><!-- doxytag: inherits="ucc::Conditional,ucc::Exclusive" -->
<p>Portable recursive exclusive lock.
<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::rexlock:</div>
<div class="dynsection">
<div class="center"><img src="a00491.png" border="0" usemap="#ucc_1_1rexlock_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1rexlock_inherit__map" id="ucc_1_1rexlock_inherit__map">
<area shape="rect" id="node2" href="a00040.html" title="The conditional is a common base for other thread synchronizing classes." alt="" coords="5,5,128,35"/><area shape="rect" id="node4" href="a00052.html" title="An exclusive locking protocol interface base." alt="" coords="152,5,261,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::rexlock:</div>
<div class="dynsection">
<div class="center"><img src="a00492.png" border="0" usemap="#ucc_1_1rexlock_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1rexlock_coll__map" id="ucc_1_1rexlock_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,5,128,35"/><area shape="rect" id="node4" href="a00052.html" title="An exclusive locking protocol interface base." alt="" coords="152,5,261,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="a00114.html#a98ceb073811ec191f529f143cf5ce144">getLocking</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of recursive locking levels. <a href="#a98ceb073811ec191f529f143cf5ce144"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00114.html#a85552344d668e1b95ae11d7e5392e09a">getWaiting</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of threads waiting on lock. <a href="#a85552344d668e1b95ae11d7e5392e09a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af146687ce6b60adf7e8f4a658c808df4"></a><!-- doxytag: member="ucc::rexlock::lock" ref="af146687ce6b60adf7e8f4a658c808df4" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00114.html#af146687ce6b60adf7e8f4a658c808df4">lock</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Acquire or increase locking. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a16a8e649b1f83c3ebc1d17afb55c9c4a"></a><!-- doxytag: member="ucc::rexlock::release" ref="a16a8e649b1f83c3ebc1d17afb55c9c4a" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00114.html#a16a8e649b1f83c3ebc1d17afb55c9c4a">release</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Release or decrease locking. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a18d5ed74f50c8fe6e6c87135da697a39"></a><!-- doxytag: member="ucc::rexlock::rexlock" ref="a18d5ed74f50c8fe6e6c87135da697a39" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00114.html#a18d5ed74f50c8fe6e6c87135da697a39">rexlock</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create rexlock. <br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00114.html#ada4c0c7909d6f8de4cd130cb326700ff">lock</a> (<a class="el" href="a00114.html">rexlock</a> &rex)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience method to lock a recursive lock. <a href="#ada4c0c7909d6f8de4cd130cb326700ff"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00114.html#a4e1f05cc81d586f84c81d745e3d0c7a1">release</a> (<a class="el" href="a00114.html">rexlock</a> &rex)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience method to unlock a recursive lock. <a href="#a4e1f05cc81d586f84c81d745e3d0c7a1"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Portable recursive exclusive lock. </p>
<p>This class is built from the conditional and hence does not require support for non-standard and platform specific extensions to pthread mutex to support recrusive style mutex locking. The exclusive protocol is implimented to support <a class="el" href="a00053.html" title="A kind of smart pointer object to support exclusive locking protocol.">exclusive_lock</a> referencing. </p>
<p>Definition at line <a class="el" href="a00208_source.html#l00468">468</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a98ceb073811ec191f529f143cf5ce144"></a><!-- doxytag: member="ucc::rexlock::getLocking" ref="a98ceb073811ec191f529f143cf5ce144" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned ucc::rexlock::getLocking </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the number of recursive locking levels. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>locking level. </dd></dl>
</div>
</div>
<a class="anchor" id="a85552344d668e1b95ae11d7e5392e09a"></a><!-- doxytag: member="ucc::rexlock::getWaiting" ref="a85552344d668e1b95ae11d7e5392e09a" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned ucc::rexlock::getWaiting </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the number of threads waiting on lock. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>wating thread count. </dd></dl>
</div>
</div>
<a class="anchor" id="ada4c0c7909d6f8de4cd130cb326700ff"></a><!-- doxytag: member="ucc::rexlock::lock" ref="ada4c0c7909d6f8de4cd130cb326700ff" args="(rexlock &rex)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void ucc::rexlock::lock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00114.html">rexlock</a> & </td>
<td class="paramname"> <em>rex</em></td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convenience method to lock a recursive lock. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>rex</em> </td><td>lock to lock. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00208_source.html#l00510">510</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="a00114_ada4c0c7909d6f8de4cd130cb326700ff_cgraph.png" border="0" usemap="#a00114_ada4c0c7909d6f8de4cd130cb326700ff_cgraph_map" alt=""></div>
<map name="a00114_ada4c0c7909d6f8de4cd130cb326700ff_cgraph_map" id="a00114_ada4c0c7909d6f8de4cd130cb326700ff_cgraph">
<area shape="rect" id="node3" href="a00114.html#af146687ce6b60adf7e8f4a658c808df4" title="Acquire or increase locking." alt="" coords="184,5,315,35"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a4e1f05cc81d586f84c81d745e3d0c7a1"></a><!-- doxytag: member="ucc::rexlock::release" ref="a4e1f05cc81d586f84c81d745e3d0c7a1" args="(rexlock &rex)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void ucc::rexlock::release </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00114.html">rexlock</a> & </td>
<td class="paramname"> <em>rex</em></td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convenience method to unlock a recursive lock. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>rex</em> </td><td>lock to release. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00208_source.html#l00517">517</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="a00114_a4e1f05cc81d586f84c81d745e3d0c7a1_cgraph.png" border="0" usemap="#a00114_a4e1f05cc81d586f84c81d745e3d0c7a1_cgraph_map" alt=""></div>
<map name="a00114_a4e1f05cc81d586f84c81d745e3d0c7a1_cgraph_map" id="a00114_a4e1f05cc81d586f84c81d745e3d0c7a1_cgraph">
<area shape="rect" id="node3" href="a00114.html#a16a8e649b1f83c3ebc1d17afb55c9c4a" title="Release or decrease locking." alt="" coords="205,5,357,35"/></map>
</div>
</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:41 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>
|