<!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::StackPager 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_stack_pager.html">StackPager</a></div>
<h1>ost::StackPager Class Reference</h1><!-- doxytag: class="ost::StackPager" --><!-- doxytag: inherits="ost::MemPager" -->The <a class="el" href="classost_1_1_stack_pager.html">StackPager</a> provides a repository to stash and retrieve working data in last-in-first-out order.last in first out object pager.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="misc_8h-source.html">misc.h</a>></code>
<p>
<p>Inheritance diagram for ost::StackPager:
<p><center><img src="classost_1_1_stack_pager.png" usemap="#ost::StackPager_map" border="0" alt=""></center>
<map name="ost::StackPager_map">
<area href="classost_1_1_mem_pager.html" alt="ost::MemPager" shape="rect" coords="0,0,99,24">
</map>
<a href="classost_1_1_stack_pager-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_stack_pager.html#9082f804e418179370e78a9d29da39e5">StackPager</a> (size_t pagesize)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a lifo pager as a mempager. <a href="#9082f804e418179370e78a9d29da39e5"></a><br></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_stack_pager.html#89f60f5bb478d10354268a06f1441778">push</a> (const void *object, size_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Push an arbitrary object onto the stack. <a href="#89f60f5bb478d10354268a06f1441778"></a><br></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_stack_pager.html#e8993b8e8287ceeb1e9fe46f8e3670c6">push</a> (const char *string)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Push a string onto the stack. <a href="#e8993b8e8287ceeb1e9fe46f8e3670c6"></a><br></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_stack_pager.html#4b840ef28c1c408d69d9b04729cd44a0">pull</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve next object from stack. <a href="#4b840ef28c1c408d69d9b04729cd44a0"></a><br></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_stack_pager.html#c903c181770651ee8f42717892dd9fa4">purge</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Purge the stack of all objects and memory allocations. <a href="#c903c181770651ee8f42717892dd9fa4"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>frame</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="classost_1_1_stack_pager.html">StackPager</a> provides a repository to stash and retrieve working data in last-in-first-out order.last in first out object pager.
<p>
The use of a mempager to support it's operation allows storage of arbitrary sized objects with no fixed limit.<p>
<dl compact><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> </dd></dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="9082f804e418179370e78a9d29da39e5"></a><!-- doxytag: member="ost::StackPager::StackPager" ref="9082f804e418179370e78a9d29da39e5" args="(size_t pagesize)" --><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::StackPager::StackPager </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">size_t </td>
<td class="mdname1" valign="top" nowrap> <em>pagesize</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 lifo pager as a mempager.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pagesize</em> </td><td>for memory allocation </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="4b840ef28c1c408d69d9b04729cd44a0"></a><!-- doxytag: member="ost::StackPager::pull" ref="4b840ef28c1c408d69d9b04729cd44a0" 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::StackPager::pull </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></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Retrieve next object from stack.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>object. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="c903c181770651ee8f42717892dd9fa4"></a><!-- doxytag: member="ost::StackPager::purge" ref="c903c181770651ee8f42717892dd9fa4" 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::StackPager::purge </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></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Purge the stack of all objects and memory allocations.
<p>
<p>
Reimplemented from <a class="el" href="classost_1_1_mem_pager.html#5bfdb6f2d6f569ba08c32c59efb3a012">ost::MemPager</a>. </td>
</tr>
</table>
<a class="anchor" name="e8993b8e8287ceeb1e9fe46f8e3670c6"></a><!-- doxytag: member="ost::StackPager::push" ref="e8993b8e8287ceeb1e9fe46f8e3670c6" args="(const char *string)" --><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::StackPager::push </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>string</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>
Push a string onto the stack.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>stack memory location. </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>pointer. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="89f60f5bb478d10354268a06f1441778"></a><!-- doxytag: member="ost::StackPager::push" ref="89f60f5bb478d10354268a06f1441778" args="(const void *object, size_t size)" --><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::StackPager::push </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const void * </td>
<td class="mdname" nowrap> <em>object</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>size_t </td>
<td class="mdname" nowrap> <em>size</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Push an arbitrary object onto the stack.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>stack memory location. </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>pointer to data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of data. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="misc_8h-source.html">misc.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>
