/usr/share/doc/libucommon-dev/a00053.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 | <!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::exclusive_lock 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="a00053.html">exclusive_lock</a>
</div>
</div>
<div class="contents">
<h1>ucc::exclusive_lock Class Reference</h1><!-- doxytag: class="ucc::exclusive_lock" -->
<p>A kind of smart pointer object to support exclusive locking protocol.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00185_source.html">access.h</a>></code></p>
<div class="dynheader">
Collaboration diagram for ucc::exclusive_lock:</div>
<div class="dynsection">
<div class="center"><img src="a00392.png" border="0" usemap="#ucc_1_1exclusive__lock_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1exclusive__lock_coll__map" id="ucc_1_1exclusive__lock_coll__map">
<area shape="rect" id="node2" href="a00052.html" title="An exclusive locking protocol interface base." alt="" coords="21,5,131,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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00053.html#a7942afe927aa9714bb041d0b77313700">exclusive_lock</a> (<a class="el" href="a00052.html">Exclusive</a> *object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an instance of an exclusive object reference. <a href="#a7942afe927aa9714bb041d0b77313700"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00053.html#a910272558439ec15734133585c9e4c6c">operator bool</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if the reference holds an active lock. <a href="#a910272558439ec15734133585c9e4c6c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00053.html#abf39f84fc150ee84b9ee4cf936176838">operator!</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if the reference holds an active lock. <a href="#abf39f84fc150ee84b9ee4cf936176838"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00053.html#a16e2d07f3551553eba0fbfa30c983a95">release</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Release a held lock programatically. <a href="#a16e2d07f3551553eba0fbfa30c983a95"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afd919e85fdde6c4382fe61ea03135263"></a><!-- doxytag: member="ucc::exclusive_lock::~exclusive_lock" ref="afd919e85fdde6c4382fe61ea03135263" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00053.html#afd919e85fdde6c4382fe61ea03135263">~exclusive_lock</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy reference to exclusively locked object, release lock. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A kind of smart pointer object to support exclusive locking protocol. </p>
<p>This object initiates an exclusive lock for the object being referenced when it is instanciated, and releases the exclusive lock when it is destroyed. You would pass the pointer an object that has the <a class="el" href="a00052.html" title="An exclusive locking protocol interface base.">Exclusive</a> as a base class. </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="a00185_source.html#l00126">126</a> of file <a class="el" href="a00185_source.html">access.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a7942afe927aa9714bb041d0b77313700"></a><!-- doxytag: member="ucc::exclusive_lock::exclusive_lock" ref="a7942afe927aa9714bb041d0b77313700" args="(Exclusive *object)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::exclusive_lock::exclusive_lock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00052.html">Exclusive</a> * </td>
<td class="paramname"> <em>object</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create an instance of an exclusive object reference. </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>containing <a class="el" href="a00052.html" title="An exclusive locking protocol interface base.">Exclusive</a> base class protocol to lock. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a910272558439ec15734133585c9e4c6c"></a><!-- doxytag: member="ucc::exclusive_lock::operator bool" ref="a910272558439ec15734133585c9e4c6c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::exclusive_lock::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 reference holds an active lock. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if locking an object. </dd></dl>
<p>Definition at line <a class="el" href="a00185_source.html#l00154">154</a> of file <a class="el" href="a00185_source.html">access.h</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
<div class="center"><img src="a00053_a910272558439ec15734133585c9e4c6c_cgraph.png" border="0" usemap="#a00053_a910272558439ec15734133585c9e4c6c_cgraph_map" alt=""></div>
<map name="a00053_a910272558439ec15734133585c9e4c6c_cgraph_map" id="a00053_a910272558439ec15734133585c9e4c6c_cgraph">
<area shape="rect" id="node3" href="a00214.html#a72818707e51af1a21b83b8ea39b95daa" title="Convenience function to exclusively lock an object through it's protocol." alt="" coords="291,5,368,35"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="abf39f84fc150ee84b9ee4cf936176838"></a><!-- doxytag: member="ucc::exclusive_lock::operator!" ref="abf39f84fc150ee84b9ee4cf936176838" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::exclusive_lock::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 reference holds an active lock. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if is not locking an object. </dd></dl>
<p>Definition at line <a class="el" href="a00185_source.html#l00147">147</a> of file <a class="el" href="a00185_source.html">access.h</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
<div class="center"><img src="a00053_abf39f84fc150ee84b9ee4cf936176838_cgraph.png" border="0" usemap="#a00053_abf39f84fc150ee84b9ee4cf936176838_cgraph_map" alt=""></div>
<map name="a00053_abf39f84fc150ee84b9ee4cf936176838_cgraph_map" id="a00053_abf39f84fc150ee84b9ee4cf936176838_cgraph">
<area shape="rect" id="node3" href="a00214.html#a72818707e51af1a21b83b8ea39b95daa" title="Convenience function to exclusively lock an object through it's protocol." alt="" coords="264,5,341,35"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a16e2d07f3551553eba0fbfa30c983a95"></a><!-- doxytag: member="ucc::exclusive_lock::release" ref="a16e2d07f3551553eba0fbfa30c983a95" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::exclusive_lock::release </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Release a held lock programatically. </p>
<p>This can be used to de-reference the object being exclusively locked without having to wait for the destructor to be called when the <a class="el" href="a00053.html" title="A kind of smart pointer object to support exclusive locking protocol.">exclusive_lock</a> falls out of scope. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00185_source.html">access.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:29 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>
|