<!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: ucommon::shared_pointer< T > Class Template 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="a00208.html">ucommon</a>::<a class="el" href="a00124.html">shared_pointer</a>
</div>
</div>
<div class="contents">
<h1>ucommon::shared_pointer< T > Class Template Reference</h1><!-- doxytag: class="ucommon::shared_pointer" --><!-- doxytag: inherits="ucommon::SharedPointer" -->
<p>Templated shared pointer for singleton shared objects of specific type.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00202_source.html">thread.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucommon::shared_pointer< T >:</div>
<div class="dynsection">
<div class="center"><img src="a00500.png" border="0" usemap="#ucommon_1_1shared__pointer_3_01_t_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="ucommon_1_1shared__pointer_3_01_t_01_4_inherit__map" id="ucommon_1_1shared__pointer_3_01_t_01_4_inherit__map">
<area shape="rect" id="node2" href="a00127.html" title="The shared pointer is used to manage a singleton instance of shared object." alt="" coords="35,155,277,181"/><area shape="rect" id="node4" href="a00037.html" title="The conditional rw seperates scheduling for optizming behavior or rw locks." alt="" coords="15,80,297,107"/><area shape="rect" id="node6" href="a00036.html" title="The conditional is a common base for other thread synchronizing classes." alt="" coords="45,5,267,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucommon::shared_pointer< T >:</div>
<div class="dynsection">
<div class="center"><img src="a00501.png" border="0" usemap="#ucommon_1_1shared__pointer_3_01_t_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="ucommon_1_1shared__pointer_3_01_t_01_4_coll__map" id="ucommon_1_1shared__pointer_3_01_t_01_4_coll__map">
<area shape="rect" id="node2" href="a00127.html" title="The shared pointer is used to manage a singleton instance of shared object." alt="" coords="236,173,479,200"/><area shape="rect" id="node4" href="a00037.html" title="The conditional rw seperates scheduling for optizming behavior or rw locks." alt="" coords="5,83,288,109"/><area shape="rect" id="node6" href="a00036.html" title="The conditional is a common base for other thread synchronizing classes." alt="" coords="36,5,257,32"/><area shape="rect" id="node8" href="a00126.html" title="Shared singleton object." alt="" coords="312,83,544,109"/></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">const T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00124.html#a4fd9d2aa0c289fbe9d6c3fb7cb86da63">dup</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Acquire a shared (duplocate) reference to the typed singleton object. <a href="#a4fd9d2aa0c289fbe9d6c3fb7cb86da63"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00124.html#a5811a7031c50edfbda34b2d177dd3749">operator*</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Access shared lock typed singleton object by pointer reference. <a href="#a5811a7031c50edfbda34b2d177dd3749"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00124.html#a6b6731b3d2ecd4e31879961addcdfa62">operator=</a> (T *object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Replace existing typed singleton object through assignment. <a href="#a6b6731b3d2ecd4e31879961addcdfa62"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00124.html#aee893814ee0e56640b19e670c12f3625">replace</a> (T *object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Replace existing typed singleton instance with new one. <a href="#aee893814ee0e56640b19e670c12f3625"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac1eda7d9ebc8f9a8d7732f5ed48db906"></a><!-- doxytag: member="ucommon::shared_pointer::shared_pointer" ref="ac1eda7d9ebc8f9a8d7732f5ed48db906" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00124.html#ac1eda7d9ebc8f9a8d7732f5ed48db906">shared_pointer</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Created shared locking for typed singleton pointer. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<class T><br/>
class ucommon::shared_pointer< T ></h3>
<p>Templated shared pointer for singleton shared objects of specific type. </p>
<p>This is used as typed template for the <a class="el" href="a00127.html" title="The shared pointer is used to manage a singleton instance of shared object.">SharedPointer</a> object reference management class. This is used to supply a typed singleton shared instance to the typed <a class="el" href="a00122.html" title="A templated smart pointer instance for shared singleton typed objects.">shared_instance</a> template 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="a00202_source.html#l01829">1829</a> of file <a class="el" href="a00202_source.html">thread.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a4fd9d2aa0c289fbe9d6c3fb7cb86da63"></a><!-- doxytag: member="ucommon::shared_pointer::dup" ref="a4fd9d2aa0c289fbe9d6c3fb7cb86da63" args="(void)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="memname">
<tr>
<td class="memname">const T* <a class="el" href="a00124.html">ucommon::shared_pointer</a>< T >::dup </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Acquire a shared (duplocate) reference to the typed singleton object. </p>
<p>This is a form of shared access lock. Derived classes and templates access conditionallock "release" when the shared pointer is no longer needed. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>typed shared object. </dd></dl>
<p>Definition at line <a class="el" href="a00202_source.html#l01844">1844</a> of file <a class="el" href="a00202_source.html">thread.h</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
<div class="center"><img src="a00124_a4fd9d2aa0c289fbe9d6c3fb7cb86da63_cgraph.png" border="0" usemap="#a00124_a4fd9d2aa0c289fbe9d6c3fb7cb86da63_cgraph_map" alt=""></div>
<map name="a00124_a4fd9d2aa0c289fbe9d6c3fb7cb86da63_cgraph_map" id="a00124_a4fd9d2aa0c289fbe9d6c3fb7cb86da63_cgraph">
<area shape="rect" id="node3" href="a00208.html#aa738a981d717c379a3facda88eafbdea" title="Convenience function to restore shared locking for object through it's protocol..." alt="" coords="357,5,520,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a5811a7031c50edfbda34b2d177dd3749"></a><!-- doxytag: member="ucommon::shared_pointer::operator*" ref="a5811a7031c50edfbda34b2d177dd3749" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="memname">
<tr>
<td class="memname">T* <a class="el" href="a00124.html">ucommon::shared_pointer</a>< T >::operator* </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Access shared lock typed singleton object by pointer reference. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>typed shared object. </dd></dl>
<p>Definition at line <a class="el" href="a00202_source.html#l01867">1867</a> of file <a class="el" href="a00202_source.html">thread.h</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
<div class="center"><img src="a00124_a5811a7031c50edfbda34b2d177dd3749_cgraph.png" border="0" usemap="#a00124_a5811a7031c50edfbda34b2d177dd3749_cgraph_map" alt=""></div>
<map name="a00124_a5811a7031c50edfbda34b2d177dd3749_cgraph_map" id="a00124_a5811a7031c50edfbda34b2d177dd3749_cgraph">
<area shape="rect" id="node3" href="a00208.html#a8048c8716eafab6b193a59529650db5c" title="Convenience function to duplicate object pointer to heap." alt="" coords="417,5,559,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a6b6731b3d2ecd4e31879961addcdfa62"></a><!-- doxytag: member="ucommon::shared_pointer::operator=" ref="a6b6731b3d2ecd4e31879961addcdfa62" args="(T *object)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00124.html">ucommon::shared_pointer</a>< T >::operator= </td>
<td>(</td>
<td class="paramtype">T * </td>
<td class="paramname"> <em>object</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Replace existing typed singleton object through assignment. </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 assign. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00202_source.html#l01860">1860</a> of file <a class="el" href="a00202_source.html">thread.h</a>.</p>
</div>
</div>
<a class="anchor" id="aee893814ee0e56640b19e670c12f3625"></a><!-- doxytag: member="ucommon::shared_pointer::replace" ref="aee893814ee0e56640b19e670c12f3625" args="(T *object)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00124.html">ucommon::shared_pointer</a>< T >::replace </td>
<td>(</td>
<td class="paramtype">T * </td>
<td class="paramname"> <em>object</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Replace existing typed singleton instance with new one. </p>
<p>This happens during exclusive locking, and the commit method of the typed 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>
<p>Definition at line <a class="el" href="a00202_source.html#l01853">1853</a> of file <a class="el" href="a00202_source.html">thread.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00202_source.html">thread.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Jul 14 16:39:57 2011 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>
distrib
>
Mandriva
>
2010.2
>
i586
>
media
>
contrib-backports
>
by-pkgid
>
4f5f2dc0f55b453456458df885792b0b
>
files
>
291
