<!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::mutex_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="a00088.html">mutex_pointer</a>
</div>
</div>
<div class="contents">
<h1>ucommon::mutex_pointer< T > Class Template Reference</h1><!-- doxytag: class="ucommon::mutex_pointer" --><!-- doxytag: inherits="ucommon::auto_protect" -->
<p>Typed smart locked pointer class.
<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::mutex_pointer< T >:</div>
<div class="dynsection">
<div class="center"><img src="a00446.png" border="0" usemap="#ucommon_1_1mutex__pointer_3_01_t_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="ucommon_1_1mutex__pointer_3_01_t_01_4_inherit__map" id="ucommon_1_1mutex__pointer_3_01_t_01_4_inherit__map">
<area shape="rect" id="node2" href="a00022.html" title="A mutex locked object smart pointer helper class." alt="" coords="35,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::mutex_pointer< T >:</div>
<div class="dynsection">
<div class="center"><img src="a00447.png" border="0" usemap="#ucommon_1_1mutex__pointer_3_01_t_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="ucommon_1_1mutex__pointer_3_01_t_01_4_coll__map" id="ucommon_1_1mutex__pointer_3_01_t_01_4_coll__map">
<area shape="rect" id="node2" href="a00022.html" title="A mutex locked object smart pointer helper class." alt="" coords="35,5,267,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">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00088.html#a66cde8fab242a2cac2cdb95eebcf41ac">get</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get pointer to object. <a href="#a66cde8fab242a2cac2cdb95eebcf41ac"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00088.html#a65881941ef2b1bf4fb4de7eecac549e9">mutex_pointer</a> (T *object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a pointer with a reference to a heap object. <a href="#a65881941ef2b1bf4fb4de7eecac549e9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0b44354f1a27542167cd3f7d6b29c599"></a><!-- doxytag: member="ucommon::mutex_pointer::mutex_pointer" ref="a0b44354f1a27542167cd3f7d6b29c599" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00088.html#a0b44354f1a27542167cd3f7d6b29c599">mutex_pointer</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a pointer with no reference. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00088.html#a56f4f4071fcd9fff414c38bf64e6a343">operator*</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reference object we are pointing to through pointer indirection. <a href="#a56f4f4071fcd9fff414c38bf64e6a343"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00088.html#aa729c81295dd9b0d5c3653faa3f9298a">operator-></a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reference member of object we are pointing to. <a href="#aa729c81295dd9b0d5c3653faa3f9298a"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<class T><br/>
class ucommon::mutex_pointer< T ></h3>
<p>Typed smart locked pointer class. </p>
<p>This is used to manage references to objects which are protected by an auto-generated mutex. The mutex is released when the pointer falls out of scope. </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#l02009">2009</a> of file <a class="el" href="a00202_source.html">thread.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a65881941ef2b1bf4fb4de7eecac549e9"></a><!-- doxytag: member="ucommon::mutex_pointer::mutex_pointer" ref="a65881941ef2b1bf4fb4de7eecac549e9" args="(T *object)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00088.html">ucommon::mutex_pointer</a>< T >::<a class="el" href="a00088.html">mutex_pointer</a> </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>Create a pointer with a reference to a heap object. </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>we are referencing. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00202_source.html#l02021">2021</a> of file <a class="el" href="a00202_source.html">thread.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a66cde8fab242a2cac2cdb95eebcf41ac"></a><!-- doxytag: member="ucommon::mutex_pointer::get" ref="a66cde8fab242a2cac2cdb95eebcf41ac" args="(void) const " -->
<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="a00088.html">ucommon::mutex_pointer</a>< T >::get </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get pointer to object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer or NULL if we are not referencing an object. </dd></dl>
<p>Definition at line <a class="el" href="a00202_source.html#l02041">2041</a> of file <a class="el" href="a00202_source.html">thread.h</a>.</p>
</div>
</div>
<a class="anchor" id="a56f4f4071fcd9fff414c38bf64e6a343"></a><!-- doxytag: member="ucommon::mutex_pointer::operator*" ref="a56f4f4071fcd9fff414c38bf64e6a343" args="() const " -->
<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="a00088.html">ucommon::mutex_pointer</a>< T >::operator* </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reference object we are pointing to through pointer indirection. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>object we are pointing to. </dd></dl>
<p>Definition at line <a class="el" href="a00202_source.html#l02027">2027</a> of file <a class="el" href="a00202_source.html">thread.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa729c81295dd9b0d5c3653faa3f9298a"></a><!-- doxytag: member="ucommon::mutex_pointer::operator->" ref="aa729c81295dd9b0d5c3653faa3f9298a" args="() const " -->
<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="a00088.html">ucommon::mutex_pointer</a>< T >::operator-> </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reference member of object we are pointing to. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>reference to member of pointed object. </dd></dl>
<p>Definition at line <a class="el" href="a00202_source.html#l02034">2034</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:46 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
>
186
