<!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::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="a00208.html">ucommon</a>::<a class="el" href="a00071.html">locked_release</a>
</div>
</div>
<div class="contents">
<h1>ucommon::locked_release Class Reference</h1><!-- doxytag: class="ucommon::locked_release" -->
<p>Auto-pointer support class for locked objects.
<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::locked_release:</div>
<div class="dynsection">
<div class="center"><img src="a00417.png" border="0" usemap="#ucommon_1_1locked__release_inherit__map" alt="Inheritance graph"/></div>
<map name="ucommon_1_1locked__release_inherit__map" id="ucommon_1_1locked__release_inherit__map">
<area shape="rect" id="node3" href="a00069.html" title="A templated smart pointer instance for lock protected objects." alt="" coords="5,80,317,107"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucommon::locked_release:</div>
<div class="dynsection">
<div class="center"><img src="a00418.png" border="0" usemap="#ucommon_1_1locked__release_coll__map" alt="Collaboration graph"/></div>
<map name="ucommon_1_1locked__release_coll__map" id="ucommon_1_1locked__release_coll__map">
<area shape="rect" id="node2" href="a00095.html" title="A common base class for all managed objects." alt="" coords="5,5,256,32"/></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="a00071.html#a4a9b7d4af00f95d40cfde16e39e04824">locked_release</a> (<a class="el" href="a00072.html">LockedPointer</a> &<a class="el" href="a00110.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="a00072.html" title="An object pointer that uses mutex to assure thread-safe singleton use.">LockedPointer</a>. <a href="#a4a9b7d4af00f95d40cfde16e39e04824"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00071.html">locked_release</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00071.html#a26d0d6b3ab33777c941db4ffbe1d8991">operator=</a> (<a class="el" href="a00072.html">LockedPointer</a> &<a class="el" href="a00110.html">pointer</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assign a locked object pointer. <a href="#a26d0d6b3ab33777c941db4ffbe1d8991"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a464bd44f30f5a50d7fe598b61d55a243"></a><!-- doxytag: member="ucommon::locked_release::release" ref="a464bd44f30f5a50d7fe598b61d55a243" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00071.html#a464bd44f30f5a50d7fe598b61d55a243">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="a00071.html#a4d9e51dca8a18fb0ec7d0b5a7f066a3f">~locked_release</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Auto-release pointer to locked object instance. <a href="#a4d9e51dca8a18fb0ec7d0b5a7f066a3f"></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="a00071.html#ac3e63d031b0117b1173f4ce161faefe2">locked_release</a> (const <a class="el" href="a00071.html">locked_release</a> &<a class="el" href="a00071.html#a2310566361a78e237abc1ab7d871312c">object</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a locked object instance base from an existing instance. <a href="#ac3e63d031b0117b1173f4ce161faefe2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a32a64d5417b61865db67e99f7119bbed"></a><!-- doxytag: member="ucommon::locked_release::locked_release" ref="a32a64d5417b61865db67e99f7119bbed" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00071.html#a32a64d5417b61865db67e99f7119bbed">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="a2310566361a78e237abc1ab7d871312c"></a><!-- doxytag: member="ucommon::locked_release::object" ref="a2310566361a78e237abc1ab7d871312c" args="" -->
<a class="el" href="a00095.html">ObjectProtocol</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00071.html#a2310566361a78e237abc1ab7d871312c">object</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">locked object protected by <a class="el" href="a00071.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="a00069.html" title="A templated smart pointer instance for lock protected objects.">locked_instance</a> class that uses the managed <a class="el" href="a00072.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="a00202_source.html#l01718">1718</a> of file <a class="el" href="a00202_source.html">thread.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ac3e63d031b0117b1173f4ce161faefe2"></a><!-- doxytag: member="ucommon::locked_release::locked_release" ref="ac3e63d031b0117b1173f4ce161faefe2" args="(const locked_release &object)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucommon::locked_release::locked_release </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00071.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="a4a9b7d4af00f95d40cfde16e39e04824"></a><!-- doxytag: member="ucommon::locked_release::locked_release" ref="a4a9b7d4af00f95d40cfde16e39e04824" args="(LockedPointer &pointer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucommon::locked_release::locked_release </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00072.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="a00072.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="a00072.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="a4d9e51dca8a18fb0ec7d0b5a7f066a3f"></a><!-- doxytag: member="ucommon::locked_release::~locked_release" ref="a4d9e51dca8a18fb0ec7d0b5a7f066a3f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucommon::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="a26d0d6b3ab33777c941db4ffbe1d8991"></a><!-- doxytag: member="ucommon::locked_release::operator=" ref="a26d0d6b3ab33777c941db4ffbe1d8991" args="(LockedPointer &pointer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00071.html">locked_release</a>& ucommon::locked_release::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00072.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="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:42 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
>
166
