<!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>GNU CommonC++: ost::RefPointer 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="index.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>Classes</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>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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="navpath"><a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_ref_pointer.html">RefPointer</a>
</div>
</div>
<div class="contents">
<h1>ost::RefPointer Class Reference</h1><!-- doxytag: class="ost::RefPointer" -->
<p><a class="el" href="classost_1_1_pointer.html" title="Used to create and manage referece counted pointers.">Pointer</a> to reference counted objects.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="object_8h_source.html">object.h</a>></code></p>
<p><a href="classost_1_1_ref_pointer-members.html">List of all members.</a></p>
<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="classost_1_1_ref_pointer.html#a76e5c23d1db92f2a334253747ec86ce4">RefPointer</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an unattached pointer. <a href="#a76e5c23d1db92f2a334253747ec86ce4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#a80c9557ad1f14596bb0040fa10ea04bf">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="#a80c9557ad1f14596bb0040fa10ea04bf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#a81ab48c97d11e952061ae222dfde6128">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="#a81ab48c97d11e952061ae222dfde6128"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#a46bf017249d0f9b5cf5ff908dc4b964e">~RefPointer</a> ()</td></tr>
<tr><td class="memItemLeft" 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#aa78d62e51e06b7b3bdd994515d0dd643">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#a1a3547c5e0bd7f72b08dd98586545ca8">ref</a>)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#a6eef018020e060eb767e32217f080c4c">operator*</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#a1c917f739b1a3394e4046ae87582b68d">operator-></a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#aa46b6b5050d934ae90a38d79c4ec740c">getObject</a> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#af45f0a5749479e8b138c87bfd5025c65">operator!</a> () const </td></tr>
<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="classost_1_1_ref_pointer.html#ab44f3d899d0ecad72570cb1bc6fca0ea">detach</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Detach current object, for example, when changing pointer. <a href="#ab44f3d899d0ecad72570cb1bc6fca0ea"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#a2ed9fa3807843a175185e99cd97b1600">enterLock</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Patch point for mutex in derived class. <a href="#a2ed9fa3807843a175185e99cd97b1600"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#aa765f7f9d45d021dfc308f30b509f959">leaveLock</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Patch point for a mutex in derived class. <a href="#aa765f7f9d45d021dfc308f30b509f959"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" 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#a1a3547c5e0bd7f72b08dd98586545ca8">ref</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="classost_1_1_pointer.html" title="Used to create and manage referece counted pointers.">Pointer</a> to reference counted objects. </p>
<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 class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> <a class="el" href="classost_1_1_pointer.html" title="Used to create and manage referece counted pointers.">Pointer</a> to reference count managed objects. </dd></dl>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a76e5c23d1db92f2a334253747ec86ce4"></a><!-- doxytag: member="ost::RefPointer::RefPointer" ref="a76e5c23d1db92f2a334253747ec86ce4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::RefPointer::RefPointer </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create an unattached pointer. </p>
</div>
</div>
<a class="anchor" id="a80c9557ad1f14596bb0040fa10ea04bf"></a><!-- doxytag: member="ost::RefPointer::RefPointer" ref="a80c9557ad1f14596bb0040fa10ea04bf" args="(RefObject *obj)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::RefPointer::RefPointer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classost_1_1_ref_object.html">RefObject</a> * </td>
<td class="paramname"> <em>obj</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a pointer attached to a reference counted object. </p>
<p>Object being referenced. </p>
</div>
</div>
<a class="anchor" id="a81ab48c97d11e952061ae222dfde6128"></a><!-- doxytag: member="ost::RefPointer::RefPointer" ref="a81ab48c97d11e952061ae222dfde6128" args="(const RefPointer &ptr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::RefPointer::RefPointer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_ref_pointer.html">RefPointer</a> & </td>
<td class="paramname"> <em>ptr</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A copy constructor. </p>
<p><a class="el" href="classost_1_1_pointer.html" title="Used to create and manage referece counted pointers.">Pointer</a> being copied. </p>
</div>
</div>
<a class="anchor" id="a46bf017249d0f9b5cf5ff908dc4b964e"></a><!-- doxytag: member="ost::RefPointer::~RefPointer" ref="a46bf017249d0f9b5cf5ff908dc4b964e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ost::RefPointer::~RefPointer </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab44f3d899d0ecad72570cb1bc6fca0ea"></a><!-- doxytag: member="ost::RefPointer::detach" ref="ab44f3d899d0ecad72570cb1bc6fca0ea" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::RefPointer::detach </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>Detach current object, for example, when changing pointer. </p>
</div>
</div>
<a class="anchor" id="a2ed9fa3807843a175185e99cd97b1600"></a><!-- doxytag: member="ost::RefPointer::enterLock" ref="a2ed9fa3807843a175185e99cd97b1600" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ost::RefPointer::enterLock </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Patch point for mutex in derived class. </p>
<p>This may often be a single static mutex shared by a managed type. </p>
</div>
</div>
<a class="anchor" id="aa46b6b5050d934ae90a38d79c4ec740c"></a><!-- doxytag: member="ost::RefPointer::getObject" ref="aa46b6b5050d934ae90a38d79c4ec740c" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* ost::RefPointer::getObject </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aa765f7f9d45d021dfc308f30b509f959"></a><!-- doxytag: member="ost::RefPointer::leaveLock" ref="aa765f7f9d45d021dfc308f30b509f959" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ost::RefPointer::leaveLock </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Patch point for a mutex in derived class. </p>
<p>This may often be a single static mutex shared by a managed type. </p>
</div>
</div>
<a class="anchor" id="af45f0a5749479e8b138c87bfd5025c65"></a><!-- doxytag: member="ost::RefPointer::operator!" ref="af45f0a5749479e8b138c87bfd5025c65" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ost::RefPointer::operator! </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a6eef018020e060eb767e32217f080c4c"></a><!-- doxytag: member="ost::RefPointer::operator*" ref="a6eef018020e060eb767e32217f080c4c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* ost::RefPointer::operator* </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a1c917f739b1a3394e4046ae87582b68d"></a><!-- doxytag: member="ost::RefPointer::operator->" ref="a1c917f739b1a3394e4046ae87582b68d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* ost::RefPointer::operator-> </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aa78d62e51e06b7b3bdd994515d0dd643"></a><!-- doxytag: member="ost::RefPointer::operator=" ref="aa78d62e51e06b7b3bdd994515d0dd643" args="(const RefObject &ref)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_ref_pointer.html">RefPointer</a>& ost::RefPointer::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_ref_object.html">RefObject</a> & </td>
<td class="paramname"> <em>ref</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a1a3547c5e0bd7f72b08dd98586545ca8"></a><!-- doxytag: member="ost::RefPointer::ref" ref="a1a3547c5e0bd7f72b08dd98586545ca8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_ref_object.html">RefObject</a>* <a class="el" href="classost_1_1_ref_pointer.html#a1a3547c5e0bd7f72b08dd98586545ca8">ost::RefPointer::ref</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<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></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Nov 12 09:55:47 2010 for GNU CommonC++ 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>
