<!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: PagerObject Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ucommon</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<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>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 id="navrow2" class="tabs2">
<ul class="tablist">
<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="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('a00102.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<h1>PagerObject Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="PagerObject" --><!-- doxytag: inherits="LinkedObject,CountedObject" -->
<p>This is a base class for objects that may be created in pager pools.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00189_source.html">memory.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for PagerObject:</div>
<div class="dyncontent">
<div class="center"><img src="a00405.png" border="0" usemap="#_pager_object_inherit__map" alt="Inheritance graph"/></div>
<map name="_pager_object_inherit__map" id="_pager_object_inherit__map">
<area shape="rect" id="node2" href="a00065.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="5,80,147,107"/><area shape="rect" id="node4" href="a00091.html" title="A common base class for all managed objects." alt="" coords="120,5,203,32"/><area shape="rect" id="node6" href="a00037.html" title="A base class for reference counted objects." alt="" coords="171,80,323,107"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for PagerObject:</div>
<div class="dyncontent">
<div class="center"><img src="a00406.png" border="0" usemap="#_pager_object_coll__map" alt="Collaboration graph"/></div>
<map name="_pager_object_coll__map" id="_pager_object_coll__map">
<area shape="rect" id="node2" href="a00065.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="5,91,147,117"/><area shape="rect" id="node10" href="a00103.html" title="Pager pool base class for managed memory pools." alt="" coords="79,200,191,227"/><area shape="rect" id="node4" href="a00091.html" title="A common base class for all managed objects." alt="" coords="156,5,239,32"/><area shape="rect" id="node7" href="a00037.html" title="A base class for reference counted objects." alt="" coords="173,149,325,176"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8c815d28288fa855ce753b384c6d4b50"></a><!-- doxytag: member="PagerObject::dealloc" ref="a8c815d28288fa855ce753b384c6d4b50" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00102.html#a8c815d28288fa855ce753b384c6d4b50">dealloc</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the pager object back to it's originating pool. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00102.html#aaf722ffb44d5ad76df29f0f5550b446f">PagerObject</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a pager object. <a href="#aaf722ffb44d5ad76df29f0f5550b446f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad05f78e37d284a54e1598560133b135d"></a><!-- doxytag: member="PagerObject::release" ref="ad05f78e37d284a54e1598560133b135d" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00102.html#ad05f78e37d284a54e1598560133b135d">release</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Release a pager object reference. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad8ed693b7d872156edf90efa1b058d3d"></a><!-- doxytag: member="PagerObject::pager" ref="ad8ed693b7d872156edf90efa1b058d3d" args="" -->
<a class="el" href="a00103.html">PagerPool</a> * </td><td class="memItemRight" valign="bottom"><b>pager</b></td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2817815065c481afe2c9aeeb18417815"></a><!-- doxytag: member="PagerObject::PagerPool" ref="a2817815065c481afe2c9aeeb18417815" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00102.html#a2817815065c481afe2c9aeeb18417815">PagerPool</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This is a base class for objects that may be created in pager pools. </p>
<p>This is also used to create objects which can be maintained as managed memory and returned to a pool. The linked list is used when freeing and re-allocating the object. These objects are reference counted so that they are returned to the pool they come from automatically when falling out of scope. This can be used to create automatic garbage collection pools. </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="a00189_source.html#l00325">325</a> of file <a class="el" href="a00189_source.html">memory.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aaf722ffb44d5ad76df29f0f5550b446f"></a><!-- doxytag: member="PagerObject::PagerObject" ref="aaf722ffb44d5ad76df29f0f5550b446f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PagerObject::PagerObject </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a pager object. </p>
<p>This is object is constructed by a <a class="el" href="a00103.html" title="Pager pool base class for managed memory pools.">PagerPool</a>. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00189_source.html">memory.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="a00102.html">PagerObject</a> </li>
<li class="footer">Generated on Wed Apr 13 2011 22:39:48 for ucommon by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
