/usr/share/doc/libucommon-dev/a00141.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 | <!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::SharedPointer 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="a00141.html">SharedPointer</a>
</div>
</div>
<div class="contents">
<h1>ucc::SharedPointer Class Reference</h1><!-- doxytag: class="ucc::SharedPointer" --><!-- doxytag: inherits="ucc::ConditionalAccess" -->
<p>The shared pointer is used to manage a singleton instance of shared object.
<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::SharedPointer:</div>
<div class="dynsection">
<div class="center"><img src="a00531.png" border="0" usemap="#ucc_1_1_shared_pointer_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1_shared_pointer_inherit__map" id="ucc_1_1_shared_pointer_inherit__map">
<area shape="rect" id="node7" href="a00138.html" title="Templated shared pointer for singleton shared objects of specific type." alt="" coords="5,237,189,267"/><area shape="rect" id="node2" href="a00041.html" title="The conditional rw seperates scheduling for optizming behavior or rw locks." alt="" coords="13,83,181,112"/><area shape="rect" id="node4" href="a00040.html" title="The conditional is a common base for other thread synchronizing classes." alt="" coords="36,5,159,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucc::SharedPointer:</div>
<div class="dynsection">
<div class="center"><img src="a00532.png" border="0" usemap="#ucc_1_1_shared_pointer_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1_shared_pointer_coll__map" id="ucc_1_1_shared_pointer_coll__map">
<area shape="rect" id="node2" 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="node4" 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="node6" 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>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00141.html#aae4a3eb58ce463064c680a7569f5f33c">replace</a> (<a class="el" href="a00140.html">SharedObject</a> *object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Replace existing singleton instance with new one. <a href="#aae4a3eb58ce463064c680a7569f5f33c"></a><br/></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="a00141.html#aed34483e28aa2d95abbf1bda5cb06119">share</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Acquire a shared reference to the singleton object. <a href="#aed34483e28aa2d95abbf1bda5cb06119"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00141.html#ac62749d06f052afc7eb6cd12cff8c5d6">SharedPointer</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Created shared locking for pointer. <a href="#ac62749d06f052afc7eb6cd12cff8c5d6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa9645ff5b3a5eb3ac474d9f8af587c7e"></a><!-- doxytag: member="ucc::SharedPointer::~SharedPointer" ref="aa9645ff5b3a5eb3ac474d9f8af587c7e" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00141.html#aa9645ff5b3a5eb3ac474d9f8af587c7e">~SharedPointer</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy lock and release any blocked threads. <br/></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afbd871e5d3ad2617ec3288e3e2eabda4"></a><!-- doxytag: member="ucc::SharedPointer::shared_release" ref="afbd871e5d3ad2617ec3288e3e2eabda4" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>shared_release</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The shared pointer is used to manage a singleton instance of shared object. </p>
<p>This class is used to support the templated <a class="el" href="a00138.html" title="Templated shared pointer for singleton shared objects of specific type.">shared_pointer</a> class and the <a class="el" href="a00139.html" title="Auto-pointer support class for shared singleton objects.">shared_release</a> class, and is not meant to be used directly or as a base for anything else. One or more threads may aquire a shared lock to the singleton object through this pointer, and it can only be replaced with a new singleton instance when no threads reference it. The conditional lock is used to manage shared access for use and exclusive access when modified. </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#l01409">1409</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ac62749d06f052afc7eb6cd12cff8c5d6"></a><!-- doxytag: member="ucc::SharedPointer::SharedPointer" ref="ac62749d06f052afc7eb6cd12cff8c5d6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::SharedPointer::SharedPointer </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Created shared locking for pointer. </p>
<p>Must be assigned by replace. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aae4a3eb58ce463064c680a7569f5f33c"></a><!-- doxytag: member="ucc::SharedPointer::replace" ref="aae4a3eb58ce463064c680a7569f5f33c" args="(SharedObject *object)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::SharedPointer::replace </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00140.html">SharedObject</a> * </td>
<td class="paramname"> <em>object</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Replace existing singleton instance with new one. </p>
<p>This happens during exclusive locking, and the commit method of the object will be called. </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>being set. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aed34483e28aa2d95abbf1bda5cb06119"></a><!-- doxytag: member="ucc::SharedPointer::share" ref="aed34483e28aa2d95abbf1bda5cb06119" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00140.html">SharedObject</a>* ucc::SharedPointer::share </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Acquire a shared reference to the singleton object. </p>
<p>This is a form of shared access lock. Derived classes and templates access "release" when the shared pointer is no longer needed. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>shared object. </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>
|