/usr/share/doc/libucommon-dev/a00116.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 | <!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::rwlock::gaurd_reader 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="a00115.html">rwlock</a>::<a class="el" href="a00116.html">gaurd_reader</a>
</div>
</div>
<div class="contents">
<h1>ucc::rwlock::gaurd_reader Class Reference</h1><!-- doxytag: class="ucc::rwlock::gaurd_reader" -->
<p>Gaurd class to apply scope based access locking to objects.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00208_source.html">thread.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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00116.html#a5486466bf81f93057a86adbb201ea3a3">gaurd_reader</a> (void *object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a gaurd for a specific object. <a href="#a5486466bf81f93057a86adbb201ea3a3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00116.html#aebafd0ab46a610f8769ffbb30aa02515">gaurd_reader</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an unitialized instance of gaurd. <a href="#aebafd0ab46a610f8769ffbb30aa02515"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00116.html#aee7e5bfd1593272b357004b946eb801c">operator=</a> (void *<a class="el" href="a00015.html">pointer</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set gaurd to read lock a new object. <a href="#aee7e5bfd1593272b357004b946eb801c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeb352351ef3892b59579a6a12f5bc23d"></a><!-- doxytag: member="ucc::rwlock::gaurd_reader::release" ref="aeb352351ef3892b59579a6a12f5bc23d" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00116.html#aeb352351ef3892b59579a6a12f5bc23d">release</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Prematurely release a gaurd. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00116.html#a45b8c3f3ffd74a0cf41052da5ce9517a">set</a> (void *object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set gaurd to mutex lock a new object. <a href="#a45b8c3f3ffd74a0cf41052da5ce9517a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a060ec1dd5e26fe13c19f1d26fc106309"></a><!-- doxytag: member="ucc::rwlock::gaurd_reader::~gaurd_reader" ref="a060ec1dd5e26fe13c19f1d26fc106309" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00116.html#a060ec1dd5e26fe13c19f1d26fc106309">~gaurd_reader</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Release mutex when gaurd falls out of scope. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Gaurd class to apply scope based access locking to objects. </p>
<p>The rwlock is located from the rwlock pool rather than contained in the target object, and the read lock is released when the gaurd object falls out of scope. This is essentially an automation mechanism for mutex::reader. </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#l00551">551</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aebafd0ab46a610f8769ffbb30aa02515"></a><!-- doxytag: member="ucc::rwlock::gaurd_reader::gaurd_reader" ref="aebafd0ab46a610f8769ffbb30aa02515" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::rwlock::gaurd_reader::gaurd_reader </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create an unitialized instance of gaurd. </p>
<p>Usually used with a gaurd = operator. </p>
</div>
</div>
<a class="anchor" id="a5486466bf81f93057a86adbb201ea3a3"></a><!-- doxytag: member="ucc::rwlock::gaurd_reader::gaurd_reader" ref="a5486466bf81f93057a86adbb201ea3a3" args="(void *object)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::rwlock::gaurd_reader::gaurd_reader </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 gaurd for a specific 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>to gaurd. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aee7e5bfd1593272b357004b946eb801c"></a><!-- doxytag: member="ucc::rwlock::gaurd_reader::operator=" ref="aee7e5bfd1593272b357004b946eb801c" args="(void *pointer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::rwlock::gaurd_reader::operator= </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>pointer</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set gaurd to read lock a new object. </p>
<p>If a lock is currently held, it is released. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pointer</em> </td><td>to object to gaurd. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00208_source.html#l00591">591</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>
</div>
</div>
<a class="anchor" id="a45b8c3f3ffd74a0cf41052da5ce9517a"></a><!-- doxytag: member="ucc::rwlock::gaurd_reader::set" ref="a45b8c3f3ffd74a0cf41052da5ce9517a" args="(void *object)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::rwlock::gaurd_reader::set </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 gaurd to mutex lock a new object. </p>
<p>If a lock is currently held, it is released. </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 gaurd. </td></tr>
</table>
</dd>
</dl>
</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>
|