/usr/share/doc/libucommon-dev/a00022.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 | <!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::atomic::spinlock 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="a00020.html">atomic</a>::<a class="el" href="a00022.html">spinlock</a>
</div>
</div>
<div class="contents">
<h1>ucc::atomic::spinlock Class Reference</h1><!-- doxytag: class="ucc::atomic::spinlock" -->
<p>Atomic spinlock class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00186_source.html">atomic.h</a>></code></p>
<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">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#acbaa90ba6f208ba097357205cc2397f6">acquire</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Acquire the lock. <a href="#acbaa90ba6f208ba097357205cc2397f6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acd51989d94a5a80e819e36ebd4a74ee2"></a><!-- doxytag: member="ucc::atomic::spinlock::release" ref="acd51989d94a5a80e819e36ebd4a74ee2" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#acd51989d94a5a80e819e36ebd4a74ee2">release</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Release an acquired spinlock. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5ecd797e19fb2251d610b24bada082e3"></a><!-- doxytag: member="ucc::atomic::spinlock::spinlock" ref="a5ecd797e19fb2251d610b24bada082e3" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#a5ecd797e19fb2251d610b24bada082e3">spinlock</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct and initialize spinlock. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Atomic spinlock class. </p>
<p>Used as high-performance sync lock between threads. </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="a00186_source.html#l00080">80</a> of file <a class="el" href="a00186_source.html">atomic.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="acbaa90ba6f208ba097357205cc2397f6"></a><!-- doxytag: member="ucc::atomic::spinlock::acquire" ref="acbaa90ba6f208ba097357205cc2397f6" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::atomic::spinlock::acquire </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Acquire the lock. </p>
<p>If the lock is not acquired, one "spins" by doing something else. One suggestion is using thread::yield. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if acquired. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00186_source.html">atomic.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:24 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>
|