Google Git
Sign in
android / platform / external / opencore / refs/heads/eclair-passion-release / . / doc / oscl_html / classOsclRefCounterMemFrag.html
blob: 83213d18753e4e546330bed6eaf000b7d212c139 [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>OsclRefCounterMemFrag 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>OsclRefCounterMemFrag Class Reference<br>
<small>
[<a class="el" href="group__osclbase.html">OSCL Base</a>]</small>
</h1><code>#include &lt;<a class="el" href="oscl__refcounter__memfrag_8h-source.html">oscl_refcounter_memfrag.h</a>&gt;</code>
<p>
<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="classOsclRefCounterMemFrag.html#a0">OsclRefCounterMemFrag</a> (<a class="el" href="structOsclMemoryFragment.html">OsclMemoryFragment</a> &amp;m, <a class="el" href="classOsclRefCounter.html">OsclRefCounter</a> *r, uint32 in_capacity)</td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classOsclRefCounterMemFrag.html#a1">OsclRefCounterMemFrag</a> (const OsclRefCounterMemFrag &amp;x)</td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classOsclRefCounterMemFrag.html#a2">OsclRefCounterMemFrag</a> ()</td></tr>
<tr><td nowrap align=right valign=top>OsclRefCounterMemFrag &amp;&nbsp;</td><td valign=bottom><a class="el" href="classOsclRefCounterMemFrag.html#a3">operator=</a> (const OsclRefCounterMemFrag &amp;x)</td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classOsclRefCounterMemFrag.html#a4">~OsclRefCounterMemFrag</a> ()</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOsclRefCounter.html">OsclRefCounter</a> *&nbsp;</td><td valign=bottom><a class="el" href="classOsclRefCounterMemFrag.html#a5">getRefCounter</a> ()</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="structOsclMemoryFragment.html">OsclMemoryFragment</a> &amp;&nbsp;</td><td valign=bottom><a class="el" href="classOsclRefCounterMemFrag.html#a6">getMemFrag</a> ()</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="group__osclbase.html#a25">OsclAny</a> *&nbsp;</td><td valign=bottom><a class="el" href="classOsclRefCounterMemFrag.html#a7">getMemFragPtr</a> ()</td></tr>
<tr><td nowrap align=right valign=top>uint32&nbsp;</td><td valign=bottom><a class="el" href="classOsclRefCounterMemFrag.html#a8">getMemFragSize</a> ()</td></tr>
<tr><td nowrap align=right valign=top>uint32&nbsp;</td><td valign=bottom><a class="el" href="classOsclRefCounterMemFrag.html#a9">getCapacity</a> ()</td></tr>
<tr><td nowrap align=right valign=top>uint32&nbsp;</td><td valign=bottom><a class="el" href="classOsclRefCounterMemFrag.html#a10">getCount</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Class to contain a memory fragment with it's associated reference counter.
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="OsclRefCounterMemFrag::OsclRefCounterMemFrag"></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" nowrap valign="top"> OsclRefCounterMemFrag::OsclRefCounterMemFrag </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="structOsclMemoryFragment.html">OsclMemoryFragment</a> &amp;&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>m</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="classOsclRefCounter.html">OsclRefCounter</a> *&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>r</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>uint32&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>in_capacity</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Constructor. A valid memory fragment and reference counter are required as input. The memory fragment structure will be copied locally.<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>m</em>&nbsp;</td><td>
reference to memory fragment </td></tr>
<tr><td valign=top><em>r</em>&nbsp;</td><td>
pointer to the reference counter associated with the memory fragment. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a1" doxytag="OsclRefCounterMemFrag::OsclRefCounterMemFrag"></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" nowrap valign="top"> OsclRefCounterMemFrag::OsclRefCounterMemFrag </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const OsclRefCounterMemFrag &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>x</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>
Copy constructor. </td>
</tr>
</table>
<a name="a2" doxytag="OsclRefCounterMemFrag::OsclRefCounterMemFrag"></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" nowrap valign="top"> OsclRefCounterMemFrag::OsclRefCounterMemFrag </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]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Default constructor. </td>
</tr>
</table>
<a name="a4" doxytag="OsclRefCounterMemFrag::~OsclRefCounterMemFrag"></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" nowrap valign="top"> OsclRefCounterMemFrag::~OsclRefCounterMemFrag </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]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Destructor. Removes this object's reference from the reference counter. The reference counter will not be deleted. The reference counter is designed to self-delete when it's reference count reaches 0. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a9" doxytag="OsclRefCounterMemFrag::getCapacity"></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" nowrap valign="top"> uint32 OsclRefCounterMemFrag::getCapacity </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]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Returns the capacity of the memory fragment
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
</dl> </td>
</tr>
</table>
<a name="a10" doxytag="OsclRefCounterMemFrag::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" nowrap valign="top"> uint32 OsclRefCounterMemFrag::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]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Returns the reference counter's current count. </td>
</tr>
</table>
<a name="a6" doxytag="OsclRefCounterMemFrag::getMemFrag"></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" nowrap valign="top"> <a class="el" href="structOsclMemoryFragment.html">OsclMemoryFragment</a>&amp; OsclRefCounterMemFrag::getMemFrag </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]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Returns a reference to the contained memory fragment structure. </td>
</tr>
</table>
<a name="a7" doxytag="OsclRefCounterMemFrag::getMemFragPtr"></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" nowrap valign="top"> <a class="el" href="group__osclbase.html#a25">OsclAny</a>* OsclRefCounterMemFrag::getMemFragPtr </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]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Returns a pointer to the memory fragment data. </td>
</tr>
</table>
<a name="a8" doxytag="OsclRefCounterMemFrag::getMemFragSize"></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" nowrap valign="top"> uint32 OsclRefCounterMemFrag::getMemFragSize </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]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Returns the size of the memory fragment data which equals its filled size.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
</dl> </td>
</tr>
</table>
<a name="a5" doxytag="OsclRefCounterMemFrag::getRefCounter"></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" nowrap valign="top"> <a class="el" href="classOsclRefCounter.html">OsclRefCounter</a>* OsclRefCounterMemFrag::getRefCounter </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]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Returns a pointer to the contained reference counter object </td>
</tr>
</table>
<a name="a3" doxytag="OsclRefCounterMemFrag::operator="></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" nowrap valign="top"> OsclRefCounterMemFrag&amp; OsclRefCounterMemFrag::operator= </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const OsclRefCounterMemFrag &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>x</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>
Assignment Operator </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="oscl__refcounter__memfrag_8h-source.html">oscl_refcounter_memfrag.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>