/usr/share/doc/libucommon-dev/a00139.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 | <!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::shared_release 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="a00139.html">shared_release</a>
</div>
</div>
<div class="contents">
<h1>ucc::shared_release Class Reference</h1><!-- doxytag: class="ucc::shared_release" -->
<p>Auto-pointer support class for shared singleton objects.
<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::shared_release:</div>
<div class="dynsection">
<div class="center"><img src="a00529.png" border="0" usemap="#ucc_1_1shared__release_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1shared__release_inherit__map" id="ucc_1_1shared__release_inherit__map">
<area shape="rect" id="node3" href="a00136.html" title="A templated smart pointer instance for shared singleton typed objects." alt="" coords="5,83,200,112"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucc::shared_release:</div>
<div class="dynsection">
<div class="center"><img src="a00530.png" border="0" usemap="#ucc_1_1shared__release_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1shared__release_coll__map" id="ucc_1_1shared__release_coll__map">
<area shape="rect" id="node2" href="a00141.html" title="The shared pointer is used to manage a singleton instance of shared object." alt="" coords="151,181,292,211"/><area shape="rect" id="node4" href="a00041.html" title="The conditional rw seperates scheduling for optizming behavior or rw locks." alt="" coords="5,85,173,115"/><area shape="rect" id="node6" href="a00040.html" title="The conditional is a common base for other thread synchronizing classes." alt="" coords="28,5,151,35"/><area shape="rect" id="node8" href="a00140.html" title="Shared singleton object." alt="" coords="197,85,336,115"/></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"><a class="el" href="a00140.html">SharedObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00139.html#acc0e10c53e56980479700eb4bb63a109">get</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get pointer to singleton object that we have shared lock for. <a href="#acc0e10c53e56980479700eb4bb63a109"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00139.html">shared_release</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00139.html#ada943fe3cce61541819f499b34b6c6c2">operator=</a> (<a class="el" href="a00141.html">SharedPointer</a> &<a class="el" href="a00015.html">pointer</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assign shared lock access to shared singleton. <a href="#ada943fe3cce61541819f499b34b6c6c2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa348d9476a0ac346e51b38c68bcc29c9"></a><!-- doxytag: member="ucc::shared_release::release" ref="aa348d9476a0ac346e51b38c68bcc29c9" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00139.html#aa348d9476a0ac346e51b38c68bcc29c9">release</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Manually release access to shared singleton object. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00139.html#a014926475e06569f3f92b2be4ea538eb">shared_release</a> (<a class="el" href="a00141.html">SharedPointer</a> &<a class="el" href="a00015.html">pointer</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Access lock a shared singleton instance from a <a class="el" href="a00141.html" title="The shared pointer is used to manage a singleton instance of shared object.">SharedPointer</a>. <a href="#a014926475e06569f3f92b2be4ea538eb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00139.html#a5eff43dd0f7bb8e886c5c43677b20fb2">~shared_release</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Auto-unlock shared lock for singleton instance protected by shared pointer. <a href="#a5eff43dd0f7bb8e886c5c43677b20fb2"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00139.html#a8350f4bcb3af7135fba21f7ea59721a1">shared_release</a> (const <a class="el" href="a00139.html">shared_release</a> &object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a shared object instance base from an existing instance. <a href="#a8350f4bcb3af7135fba21f7ea59721a1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa8c2b15460473974e3a2c124149fa2fa"></a><!-- doxytag: member="ucc::shared_release::shared_release" ref="aa8c2b15460473974e3a2c124149fa2fa" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00139.html#aa8c2b15460473974e3a2c124149fa2fa">shared_release</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an unassigned shared singleton object pointer base. <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="a345ad0a116ac888154406359c5dcb127"></a><!-- doxytag: member="ucc::shared_release::ptr" ref="a345ad0a116ac888154406359c5dcb127" args="" -->
<a class="el" href="a00141.html">SharedPointer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00139.html#a345ad0a116ac888154406359c5dcb127">ptr</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="a00135.html" title="An exclusive locking protocol interface base.">Shared</a> lock for protected singleton. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Auto-pointer support class for shared singleton objects. </p>
<p>This is used as a base class for the templated <a class="el" href="a00136.html" title="A templated smart pointer instance for shared singleton typed objects.">shared_instance</a> class that uses shared access locking through the <a class="el" href="a00141.html" title="The shared pointer is used to manage a singleton instance of shared object.">SharedPointer</a> class. When the shared instance falls out of scope, the <a class="el" href="a00141.html" title="The shared pointer is used to manage a singleton instance of shared object.">SharedPointer</a> lock is released. The pointer typed object must be based on the <a class="el" href="a00140.html" title="Shared singleton object.">SharedObject</a> 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="a00208_source.html#l02072">2072</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a8350f4bcb3af7135fba21f7ea59721a1"></a><!-- doxytag: member="ucc::shared_release::shared_release" ref="a8350f4bcb3af7135fba21f7ea59721a1" args="(const shared_release &object)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::shared_release::shared_release </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00139.html">shared_release</a> & </td>
<td class="paramname"> <em>object</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a shared object instance base from an existing instance. </p>
<p>This will assign an additional shared 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>object</em> </td><td>to copy from. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a014926475e06569f3f92b2be4ea538eb"></a><!-- doxytag: member="ucc::shared_release::shared_release" ref="a014926475e06569f3f92b2be4ea538eb" args="(SharedPointer &pointer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::shared_release::shared_release </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00141.html">SharedPointer</a> & </td>
<td class="paramname"> <em>pointer</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Access lock a shared singleton instance from a <a class="el" href="a00141.html" title="The shared pointer is used to manage a singleton instance of shared object.">SharedPointer</a>. </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>of shared pointer to assign from. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a5eff43dd0f7bb8e886c5c43677b20fb2"></a><!-- doxytag: member="ucc::shared_release::~shared_release" ref="a5eff43dd0f7bb8e886c5c43677b20fb2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::shared_release::~shared_release </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Auto-unlock shared lock for singleton instance protected by shared pointer. </p>
<p>This is used to unlock when the instance template falls out of scope. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="acc0e10c53e56980479700eb4bb63a109"></a><!-- doxytag: member="ucc::shared_release::get" ref="acc0e10c53e56980479700eb4bb63a109" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00140.html">SharedObject</a>* ucc::shared_release::get </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get pointer to singleton object that we have shared lock for. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>shared object singleton. </dd></dl>
</div>
</div>
<a class="anchor" id="ada943fe3cce61541819f499b34b6c6c2"></a><!-- doxytag: member="ucc::shared_release::operator=" ref="ada943fe3cce61541819f499b34b6c6c2" args="(SharedPointer &pointer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00139.html">shared_release</a>& ucc::shared_release::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00141.html">SharedPointer</a> & </td>
<td class="paramname"> <em>pointer</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assign shared lock access to shared singleton. </p>
<p>If an existing shared lock is held for another pointer, 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>access for shared object. </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:45 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>
|