/usr/share/doc/libucommon-dev/a00073.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 | <!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::locked_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="a00073.html">locked_release</a>
</div>
</div>
<div class="contents">
<h1>ucc::locked_release Class Reference</h1><!-- doxytag: class="ucc::locked_release" -->
<p>Auto-pointer support class for locked 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::locked_release:</div>
<div class="dynsection">
<div class="center"><img src="a00425.png" border="0" usemap="#ucc_1_1locked__release_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1locked__release_inherit__map" id="ucc_1_1locked__release_inherit__map">
<area shape="rect" id="node3" href="a00071.html" title="A templated smart pointer instance for lock protected objects." alt="" coords="5,83,195,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::locked_release:</div>
<div class="dynsection">
<div class="center"><img src="a00426.png" border="0" usemap="#ucc_1_1locked__release_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1locked__release_coll__map" id="ucc_1_1locked__release_coll__map">
<area shape="rect" id="node2" href="a00093.html" title="A common base class for all managed objects." alt="" coords="32,5,125,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="a00073.html#a1acab6a156fb91cdda066fc76284bf74">locked_release</a> (<a class="el" href="a00074.html">LockedPointer</a> &<a class="el" href="a00015.html">pointer</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a locked object instance base from a <a class="el" href="a00074.html" title="An object pointer that uses mutex to assure thread-safe singleton use.">LockedPointer</a>. <a href="#a1acab6a156fb91cdda066fc76284bf74"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00073.html">locked_release</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#a901e9981b3d669468d87578b91920663">operator=</a> (<a class="el" href="a00074.html">LockedPointer</a> &<a class="el" href="a00015.html">pointer</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assign a locked object pointer. <a href="#a901e9981b3d669468d87578b91920663"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae626b2e3ba2717588fc18b639b1c2efe"></a><!-- doxytag: member="ucc::locked_release::release" ref="ae626b2e3ba2717588fc18b639b1c2efe" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#ae626b2e3ba2717588fc18b639b1c2efe">release</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Manually release the object reference. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#af35dd2260cf1114d7176dcf543a46936">~locked_release</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Auto-release pointer to locked object instance. <a href="#af35dd2260cf1114d7176dcf543a46936"></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="a00073.html#a1c09e2bc84da1ef7b398f63bd1faf54c">locked_release</a> (const <a class="el" href="a00073.html">locked_release</a> &<a class="el" href="a00073.html#a953e9f679a79c0419c07c4dbf3befa9e">object</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a locked object instance base from an existing instance. <a href="#a1c09e2bc84da1ef7b398f63bd1faf54c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af0d298217b44487eb836d5eabc400269"></a><!-- doxytag: member="ucc::locked_release::locked_release" ref="af0d298217b44487eb836d5eabc400269" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#af0d298217b44487eb836d5eabc400269">locked_release</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an unassigned locked 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="a953e9f679a79c0419c07c4dbf3befa9e"></a><!-- doxytag: member="ucc::locked_release::object" ref="a953e9f679a79c0419c07c4dbf3befa9e" args="" -->
<a class="el" href="a00093.html">Object</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#a953e9f679a79c0419c07c4dbf3befa9e">object</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">locked object protected by <a class="el" href="a00073.html" title="Auto-pointer support class for locked objects.">locked_release</a> <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Auto-pointer support class for locked objects. </p>
<p>This is used as a base class for the templated <a class="el" href="a00071.html" title="A templated smart pointer instance for lock protected objects.">locked_instance</a> class that uses the managed <a class="el" href="a00074.html" title="An object pointer that uses mutex to assure thread-safe singleton use.">LockedPointer</a> to assign a reference to an object. When the locked instance falls out of scope, the object is derefenced. Ideally the pointer typed object should be based on the reference counted object 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#l02019">2019</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a1c09e2bc84da1ef7b398f63bd1faf54c"></a><!-- doxytag: member="ucc::locked_release::locked_release" ref="a1c09e2bc84da1ef7b398f63bd1faf54c" args="(const locked_release &object)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::locked_release::locked_release </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00073.html">locked_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 locked object instance base from an existing instance. </p>
<p>This will create a duplicate (retained) 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>to copy from. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1acab6a156fb91cdda066fc76284bf74"></a><!-- doxytag: member="ucc::locked_release::locked_release" ref="a1acab6a156fb91cdda066fc76284bf74" args="(LockedPointer &pointer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::locked_release::locked_release </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00074.html">LockedPointer</a> & </td>
<td class="paramname"> <em>pointer</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a locked object instance base from a <a class="el" href="a00074.html" title="An object pointer that uses mutex to assure thread-safe singleton use.">LockedPointer</a>. </p>
<p>References a retained instance of the underlying object from the <a class="el" href="a00074.html" title="An object pointer that uses mutex to assure thread-safe singleton use.">LockedPointer</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 locked pointer to assign from. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af35dd2260cf1114d7176dcf543a46936"></a><!-- doxytag: member="ucc::locked_release::~locked_release" ref="af35dd2260cf1114d7176dcf543a46936" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::locked_release::~locked_release </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Auto-release pointer to locked object instance. </p>
<p>This is used to release a reference when the pointer template falls out of scope. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a901e9981b3d669468d87578b91920663"></a><!-- doxytag: member="ucc::locked_release::operator=" ref="a901e9981b3d669468d87578b91920663" args="(LockedPointer &pointer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00073.html">locked_release</a>& ucc::locked_release::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00074.html">LockedPointer</a> & </td>
<td class="paramname"> <em>pointer</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assign a locked object pointer. </p>
<p>If an existing object is already assigned, the existing pointer 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>reference through locked 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:33 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>
|