<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>GNU CommonC++: ost::RefPointer Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.6 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></div>
<div class="nav">
<a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_ref_pointer.html">RefPointer</a></div>
<h1>ost::RefPointer Class Reference</h1><!-- doxytag: class="ost::RefPointer" --><a class="el" href="classost_1_1_pointer.html">Pointer</a> to reference counted objects.Pointer to reference count managed objects.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="object_8h-source.html">object.h</a>></code>
<p>
<a href="classost_1_1_ref_pointer-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#76e5c23d1db92f2a334253747ec86ce4">RefPointer</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an unattached pointer. <a href="#76e5c23d1db92f2a334253747ec86ce4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#80c9557ad1f14596bb0040fa10ea04bf">RefPointer</a> (<a class="el" href="classost_1_1_ref_object.html">RefObject</a> *obj)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a pointer attached to a reference counted object. <a href="#80c9557ad1f14596bb0040fa10ea04bf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#81ab48c97d11e952061ae222dfde6128">RefPointer</a> (const <a class="el" href="classost_1_1_ref_pointer.html">RefPointer</a> &ptr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A copy constructor. <a href="#81ab48c97d11e952061ae222dfde6128"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#46bf017249d0f9b5cf5ff908dc4b964e">~RefPointer</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_ref_pointer.html">RefPointer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#a78d62e51e06b7b3bdd994515d0dd643">operator=</a> (const <a class="el" href="classost_1_1_ref_object.html">RefObject</a> &<a class="el" href="classost_1_1_ref_pointer.html#1a3547c5e0bd7f72b08dd98586545ca8">ref</a>)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#02ed3a4625579a78a11aefbe2b05b38c">operator *</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#1c917f739b1a3394e4046ae87582b68d">operator-></a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#a46b6b5050d934ae90a38d79c4ec740c">getObject</a> (void) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#f45f0a5749479e8b138c87bfd5025c65">operator!</a> () const </td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#b44f3d899d0ecad72570cb1bc6fca0ea">detach</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Detach current object, for example, when changing pointer. <a href="#b44f3d899d0ecad72570cb1bc6fca0ea"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#2ed9fa3807843a175185e99cd97b1600">enterLock</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Patch point for mutex in derived class. <a href="#2ed9fa3807843a175185e99cd97b1600"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#a765f7f9d45d021dfc308f30b509f959">leaveLock</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Patch point for a mutex in derived class. <a href="#a765f7f9d45d021dfc308f30b509f959"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_ref_object.html">RefObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#1a3547c5e0bd7f72b08dd98586545ca8">ref</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classost_1_1_pointer.html">Pointer</a> to reference counted objects.Pointer to reference count managed objects.
<p>
This is a non-template form of a reference count smart pointer, and so uses common code. This can be subclassed to return explicit object types.<p>
<dl compact><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> </dd></dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="76e5c23d1db92f2a334253747ec86ce4"></a><!-- doxytag: member="ost::RefPointer::RefPointer" ref="76e5c23d1db92f2a334253747ec86ce4" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::RefPointer::RefPointer </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Create an unattached pointer.
<p>
</td>
</tr>
</table>
<a class="anchor" name="80c9557ad1f14596bb0040fa10ea04bf"></a><!-- doxytag: member="ost::RefPointer::RefPointer" ref="80c9557ad1f14596bb0040fa10ea04bf" args="(RefObject *obj)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::RefPointer::RefPointer </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_ref_object.html">RefObject</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>obj</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Create a pointer attached to a reference counted object.
<p>
Object being referenced. </td>
</tr>
</table>
<a class="anchor" name="81ab48c97d11e952061ae222dfde6128"></a><!-- doxytag: member="ost::RefPointer::RefPointer" ref="81ab48c97d11e952061ae222dfde6128" args="(const RefPointer &ptr)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::RefPointer::RefPointer </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classost_1_1_ref_pointer.html">RefPointer</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>ptr</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
A copy constructor.
<p>
<a class="el" href="classost_1_1_pointer.html">Pointer</a> being copied. </td>
</tr>
</table>
<a class="anchor" name="46bf017249d0f9b5cf5ff908dc4b964e"></a><!-- doxytag: member="ost::RefPointer::~RefPointer" ref="46bf017249d0f9b5cf5ff908dc4b964e" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual ost::RefPointer::~RefPointer </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="b44f3d899d0ecad72570cb1bc6fca0ea"></a><!-- doxytag: member="ost::RefPointer::detach" ref="b44f3d899d0ecad72570cb1bc6fca0ea" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::RefPointer::detach </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Detach current object, for example, when changing pointer.
<p>
</td>
</tr>
</table>
<a class="anchor" name="2ed9fa3807843a175185e99cd97b1600"></a><!-- doxytag: member="ost::RefPointer::enterLock" ref="2ed9fa3807843a175185e99cd97b1600" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void ost::RefPointer::enterLock </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Patch point for mutex in derived class.
<p>
This may often be a single static mutex shared by a managed type. </td>
</tr>
</table>
<a class="anchor" name="a46b6b5050d934ae90a38d79c4ec740c"></a><!-- doxytag: member="ost::RefPointer::getObject" ref="a46b6b5050d934ae90a38d79c4ec740c" args="(void) const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void* ost::RefPointer::getObject </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="a765f7f9d45d021dfc308f30b509f959"></a><!-- doxytag: member="ost::RefPointer::leaveLock" ref="a765f7f9d45d021dfc308f30b509f959" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void ost::RefPointer::leaveLock </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Patch point for a mutex in derived class.
<p>
This may often be a single static mutex shared by a managed type. </td>
</tr>
</table>
<a class="anchor" name="02ed3a4625579a78a11aefbe2b05b38c"></a><!-- doxytag: member="ost::RefPointer::operator *" ref="02ed3a4625579a78a11aefbe2b05b38c" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void* ost::RefPointer::operator * </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="f45f0a5749479e8b138c87bfd5025c65"></a><!-- doxytag: member="ost::RefPointer::operator!" ref="f45f0a5749479e8b138c87bfd5025c65" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool ost::RefPointer::operator! </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="1c917f739b1a3394e4046ae87582b68d"></a><!-- doxytag: member="ost::RefPointer::operator->" ref="1c917f739b1a3394e4046ae87582b68d" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void* ost::RefPointer::operator-> </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="a78d62e51e06b7b3bdd994515d0dd643"></a><!-- doxytag: member="ost::RefPointer::operator=" ref="a78d62e51e06b7b3bdd994515d0dd643" args="(const RefObject &ref)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_ref_pointer.html">RefPointer</a>& ost::RefPointer::operator= </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classost_1_1_ref_object.html">RefObject</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>ref</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="1a3547c5e0bd7f72b08dd98586545ca8"></a><!-- doxytag: member="ost::RefPointer::ref" ref="1a3547c5e0bd7f72b08dd98586545ca8" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_ref_object.html">RefObject</a>* <a class="el" href="classost_1_1_ref_pointer.html#1a3547c5e0bd7f72b08dd98586545ca8">ost::RefPointer::ref</a><code> [protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="object_8h-source.html">object.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 19 10:50:56 2006 for GNU CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>
