Google Git
Sign in
android / platform / external / opencore / refs/heads/eclair-passion-release / . / doc / oscl_html / classOsclRefCounterSA.html
blob: a05a7d1b4e30d04377e4e6c83c06601f0dc70d69 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> TemplateOsclRefCounterSA&lt; DeallocType &gt; class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.18 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="modules.html">Modules</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="annotated.html">Data Structures</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Data Fields</a> &nbsp; <a class="qindex" href="globals.html">Globals</a> &nbsp; </center>
<hr><h1>OsclRefCounterSA&lt; DeallocType &gt; Class Template Reference<br>
<small>
[<a class="el" href="group__osclbase.html">OSCL Base</a>]</small>
</h1><code>#include &lt;<a class="el" href="oscl__refcounter_8h-source.html">oscl_refcounter.h</a>&gt;</code>
<p>
<p>Inheritance diagram for OsclRefCounterSA&lt; DeallocType &gt;:
<p><center><img src="classOsclRefCounterSA.png" usemap="#OsclRefCounterSA< DeallocType >_map" border="0" alt=""></center>
<map name="OsclRefCounterSA< DeallocType >_map">
<area href="classOsclRefCounter.html" alt="OsclRefCounter" shape="rect" coords="0,0,214,24">
</map>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classOsclRefCounterSA.html#a0">OsclRefCounterSA</a> (<a class="el" href="group__osclbase.html#a25">OsclAny</a> *p)</td></tr>
<tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classOsclRefCounterSA.html#a1">~OsclRefCounterSA</a> ()</td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classOsclRefCounterSA.html#a2">addRef</a> ()</td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classOsclRefCounterSA.html#a3">removeRef</a> ()</td></tr>
<tr><td nowrap align=right valign=top>uint32&nbsp;</td><td valign=bottom><a class="el" href="classOsclRefCounterSA.html#a4">getCount</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class DeallocType&gt;<br>
class OsclRefCounterSA&lt; DeallocType &gt;</h3>
Implementation of an <a class="el" href="classOsclRefCounter.html">OsclRefCounter</a> that uses a statically created deallocator.
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="OsclRefCounterSA::OsclRefCounterSA"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class DeallocType&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> OsclRefCounterSA&lt; DeallocType &gt;::OsclRefCounterSA </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="group__osclbase.html#a25">OsclAny</a> *&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>p</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Constructor Takes a pointer to the buffer to track.
<p>
When the reference count reaches zero, the buffer will be deleted by the deallocator. Also, the <a class="el" href="classOsclRefCounter.html">OsclRefCounter</a> object (this) will self-destruct when the reference count is zero. In some cases the <a class="el" href="classOsclRefCounter.html">OsclRefCounter</a> object will be part of the buffer being deleted. For such cases, the object pointer must be equal to the buffer pointer given at construction. If the object is not part of the buffer being deleted, it will self-destruct with a call to delete().<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>p</em>&nbsp;</td><td>
pointer to the buffer to track </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a1" doxytag="OsclRefCounterSA::~OsclRefCounterSA"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class DeallocType&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> virtual OsclRefCounterSA&lt; DeallocType &gt;::~OsclRefCounterSA </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Destructor empty </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a2" doxytag="OsclRefCounterSA::addRef"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class DeallocType&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> void OsclRefCounterSA&lt; DeallocType &gt;::addRef </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Add to the reference count
<p>
Implements <a class="el" href="classOsclRefCounter.html#a0">OsclRefCounter</a>. </td>
</tr>
</table>
<a name="a4" doxytag="OsclRefCounterSA::getCount"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class DeallocType&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> uint32 OsclRefCounterSA&lt; DeallocType &gt;::getCount </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Gets the current number of references
<p>
Implements <a class="el" href="classOsclRefCounter.html#a2">OsclRefCounter</a>. </td>
</tr>
</table>
<a name="a3" doxytag="OsclRefCounterSA::removeRef"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class DeallocType&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> void OsclRefCounterSA&lt; DeallocType &gt;::removeRef </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Remove from the reference count
<p>
Implements <a class="el" href="classOsclRefCounter.html#a1">OsclRefCounter</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="oscl__refcounter_8h-source.html">oscl_refcounter.h</a></ul>
<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small>
<address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small>
</small></address>
</body>
</html>