<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>GNU CommonC++: ost::StackPager Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">GNU CommonC++
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<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>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 id="navrow2" class="tabs2">
<ul class="tablist">
<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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceost.html">ost</a></li><li class="navelem"><a class="el" href="classost_1_1_stack_pager.html">StackPager</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="classost_1_1_stack_pager-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ost::StackPager Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="classost_1_1_stack_pager.html" title="The StackPager provides a repository to stash and retrieve working data in last-in-first-out order...">StackPager</a> provides a repository to stash and retrieve working data in last-in-first-out order.
<a href="classost_1_1_stack_pager.html#details">More...</a></p>
<p><code>#include <<a class="el" href="misc_8h_source.html">misc.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ost::StackPager:</div>
<div class="dyncontent">
<div class="center">
<img src="classost_1_1_stack_pager.png" usemap="#ost::StackPager_map" alt=""/>
<map id="ost::StackPager_map" name="ost::StackPager_map">
<area href="classost_1_1_mem_pager.html" title="The memory pager is used to allocate cumulative memory pages for storing object specific "persistant"..." alt="ost::MemPager" shape="rect" coords="0,0,99,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a9082f804e418179370e78a9d29da39e5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_stack_pager.html#a9082f804e418179370e78a9d29da39e5">StackPager</a> (size_t pagesize)</td></tr>
<tr class="memdesc:a9082f804e418179370e78a9d29da39e5"><td class="mdescLeft"> </td><td class="mdescRight">Create a lifo pager as a mempager. <a href="#a9082f804e418179370e78a9d29da39e5">More...</a><br/></td></tr>
<tr class="separator:a9082f804e418179370e78a9d29da39e5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a89f60f5bb478d10354268a06f1441778"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_stack_pager.html#a89f60f5bb478d10354268a06f1441778">push</a> (const void *object, size_t size)</td></tr>
<tr class="memdesc:a89f60f5bb478d10354268a06f1441778"><td class="mdescLeft"> </td><td class="mdescRight">Push an arbitrary object onto the stack. <a href="#a89f60f5bb478d10354268a06f1441778">More...</a><br/></td></tr>
<tr class="separator:a89f60f5bb478d10354268a06f1441778"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae8993b8e8287ceeb1e9fe46f8e3670c6"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_stack_pager.html#ae8993b8e8287ceeb1e9fe46f8e3670c6">push</a> (const char *string)</td></tr>
<tr class="memdesc:ae8993b8e8287ceeb1e9fe46f8e3670c6"><td class="mdescLeft"> </td><td class="mdescRight">Push a string onto the stack. <a href="#ae8993b8e8287ceeb1e9fe46f8e3670c6">More...</a><br/></td></tr>
<tr class="separator:ae8993b8e8287ceeb1e9fe46f8e3670c6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4b840ef28c1c408d69d9b04729cd44a0"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_stack_pager.html#a4b840ef28c1c408d69d9b04729cd44a0">pull</a> (void)</td></tr>
<tr class="memdesc:a4b840ef28c1c408d69d9b04729cd44a0"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve next object from stack. <a href="#a4b840ef28c1c408d69d9b04729cd44a0">More...</a><br/></td></tr>
<tr class="separator:a4b840ef28c1c408d69d9b04729cd44a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac903c181770651ee8f42717892dd9fa4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_stack_pager.html#ac903c181770651ee8f42717892dd9fa4">purge</a> (void)</td></tr>
<tr class="memdesc:ac903c181770651ee8f42717892dd9fa4"><td class="mdescLeft"> </td><td class="mdescRight">Purge the stack of all objects and memory allocations. <a href="#ac903c181770651ee8f42717892dd9fa4">More...</a><br/></td></tr>
<tr class="separator:ac903c181770651ee8f42717892dd9fa4"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classost_1_1_mem_pager"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classost_1_1_mem_pager')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classost_1_1_mem_pager.html">ost::MemPager</a></td></tr>
<tr class="memitem:a2c82ac4c97fcba81c643966973e78d84 inherit pro_methods_classost_1_1_mem_pager"><td class="memItemLeft" align="right" valign="top">virtual void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_mem_pager.html#a2c82ac4c97fcba81c643966973e78d84">first</a> (size_t size)</td></tr>
<tr class="memdesc:a2c82ac4c97fcba81c643966973e78d84 inherit pro_methods_classost_1_1_mem_pager"><td class="mdescLeft"> </td><td class="mdescRight">Allocate first workspace from paged memory. <a href="#a2c82ac4c97fcba81c643966973e78d84">More...</a><br/></td></tr>
<tr class="separator:a2c82ac4c97fcba81c643966973e78d84 inherit pro_methods_classost_1_1_mem_pager"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3a03cb50bd4084ddbf6314ec0339d176 inherit pro_methods_classost_1_1_mem_pager"><td class="memItemLeft" align="right" valign="top">virtual void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_mem_pager.html#a3a03cb50bd4084ddbf6314ec0339d176">alloc</a> (size_t size)</td></tr>
<tr class="memdesc:a3a03cb50bd4084ddbf6314ec0339d176 inherit pro_methods_classost_1_1_mem_pager"><td class="mdescLeft"> </td><td class="mdescRight">Allocate memory from either the currently active page, or allocate a new page for the object. <a href="#a3a03cb50bd4084ddbf6314ec0339d176">More...</a><br/></td></tr>
<tr class="separator:a3a03cb50bd4084ddbf6314ec0339d176 inherit pro_methods_classost_1_1_mem_pager"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7ea4e6f82bffa66c994fcd10ebdee594 inherit pro_methods_classost_1_1_mem_pager"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_mem_pager.html#a7ea4e6f82bffa66c994fcd10ebdee594">first</a> (char *str)</td></tr>
<tr class="memdesc:a7ea4e6f82bffa66c994fcd10ebdee594 inherit pro_methods_classost_1_1_mem_pager"><td class="mdescLeft"> </td><td class="mdescRight">Allocate a string from the memory pager pool and copy the string into it's new memory area. <a href="#a7ea4e6f82bffa66c994fcd10ebdee594">More...</a><br/></td></tr>
<tr class="separator:a7ea4e6f82bffa66c994fcd10ebdee594 inherit pro_methods_classost_1_1_mem_pager"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a245b6c4181ccccbabc52f1c3451f2fb6 inherit pro_methods_classost_1_1_mem_pager"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_mem_pager.html#a245b6c4181ccccbabc52f1c3451f2fb6">alloc</a> (const char *str)</td></tr>
<tr class="memdesc:a245b6c4181ccccbabc52f1c3451f2fb6 inherit pro_methods_classost_1_1_mem_pager"><td class="mdescLeft"> </td><td class="mdescRight">Allocate a string from the memory pager pool and copy the string inti it's new memory area. <a href="#a245b6c4181ccccbabc52f1c3451f2fb6">More...</a><br/></td></tr>
<tr class="separator:a245b6c4181ccccbabc52f1c3451f2fb6 inherit pro_methods_classost_1_1_mem_pager"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5dc37c26af34d6f4c26e125eded3e2be inherit pro_methods_classost_1_1_mem_pager"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_mem_pager.html#a5dc37c26af34d6f4c26e125eded3e2be">MemPager</a> (size_t pagesize=4096)</td></tr>
<tr class="memdesc:a5dc37c26af34d6f4c26e125eded3e2be inherit pro_methods_classost_1_1_mem_pager"><td class="mdescLeft"> </td><td class="mdescRight">Create a paged memory pool for cumulative storage. <a href="#a5dc37c26af34d6f4c26e125eded3e2be">More...</a><br/></td></tr>
<tr class="separator:a5dc37c26af34d6f4c26e125eded3e2be inherit pro_methods_classost_1_1_mem_pager"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5bfdb6f2d6f569ba08c32c59efb3a012 inherit pro_methods_classost_1_1_mem_pager"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_mem_pager.html#a5bfdb6f2d6f569ba08c32c59efb3a012">purge</a> (void)</td></tr>
<tr class="memdesc:a5bfdb6f2d6f569ba08c32c59efb3a012 inherit pro_methods_classost_1_1_mem_pager"><td class="mdescLeft"> </td><td class="mdescRight">purge the current memory pool. <a href="#a5bfdb6f2d6f569ba08c32c59efb3a012">More...</a><br/></td></tr>
<tr class="separator:a5bfdb6f2d6f569ba08c32c59efb3a012 inherit pro_methods_classost_1_1_mem_pager"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8efb94a243063ed1f9d1ddb315cb6042 inherit pro_methods_classost_1_1_mem_pager"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_mem_pager.html#a8efb94a243063ed1f9d1ddb315cb6042">clean</a> (void)</td></tr>
<tr class="memdesc:a8efb94a243063ed1f9d1ddb315cb6042 inherit pro_methods_classost_1_1_mem_pager"><td class="mdescLeft"> </td><td class="mdescRight">Clean for memory cleanup before exiting. <a href="#a8efb94a243063ed1f9d1ddb315cb6042">More...</a><br/></td></tr>
<tr class="separator:a8efb94a243063ed1f9d1ddb315cb6042 inherit pro_methods_classost_1_1_mem_pager"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a58dcf48146eca4ae2286706968fdf9c5 inherit pro_methods_classost_1_1_mem_pager"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_mem_pager.html#a58dcf48146eca4ae2286706968fdf9c5">~MemPager</a> ()</td></tr>
<tr class="memdesc:a58dcf48146eca4ae2286706968fdf9c5 inherit pro_methods_classost_1_1_mem_pager"><td class="mdescLeft"> </td><td class="mdescRight">Delete the memory pool and all allocated memory. <a href="#a58dcf48146eca4ae2286706968fdf9c5">More...</a><br/></td></tr>
<tr class="separator:a58dcf48146eca4ae2286706968fdf9c5 inherit pro_methods_classost_1_1_mem_pager"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a320897ecfca3e92378c45ec70aee58ba inherit pro_methods_classost_1_1_mem_pager"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_mem_pager.html#a320897ecfca3e92378c45ec70aee58ba">getPages</a> (void)</td></tr>
<tr class="memdesc:a320897ecfca3e92378c45ec70aee58ba inherit pro_methods_classost_1_1_mem_pager"><td class="mdescLeft"> </td><td class="mdescRight">Return the total number of pages that have been allocated for this memory pool. <a href="#a320897ecfca3e92378c45ec70aee58ba">More...</a><br/></td></tr>
<tr class="separator:a320897ecfca3e92378c45ec70aee58ba inherit pro_methods_classost_1_1_mem_pager"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="classost_1_1_stack_pager.html" title="The StackPager provides a repository to stash and retrieve working data in last-in-first-out order...">StackPager</a> provides a repository to stash and retrieve working data in last-in-first-out order. </p>
<p>The use of a mempager to support it's operation allows storage of arbitrary sized objects with no fixed limit.</p>
<dl class="section author"><dt>Author</dt><dd>David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@os'+'te'+'l.c'+'om'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@ost<span style="display: none;">.nosp@m.</span>el.co<span style="display: none;">.nosp@m.</span>m</a> last in first out object pager. </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a9082f804e418179370e78a9d29da39e5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::StackPager::StackPager </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>pagesize</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a lifo pager as a mempager. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pagesize</td><td>for memory allocation </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a4b840ef28c1c408d69d9b04729cd44a0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* ost::StackPager::pull </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve next object from stack. </p>
<dl class="section return"><dt>Returns</dt><dd>object. </dd></dl>
</div>
</div>
<a class="anchor" id="ac903c181770651ee8f42717892dd9fa4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::StackPager::purge </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Purge the stack of all objects and memory allocations. </p>
</div>
</div>
<a class="anchor" id="a89f60f5bb478d10354268a06f1441778"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* ost::StackPager::push </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Push an arbitrary object onto the stack. </p>
<dl class="section return"><dt>Returns</dt><dd>stack memory location. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">object</td><td>pointer to data </td></tr>
<tr><td class="paramname">size</td><td>of data. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ae8993b8e8287ceeb1e9fe46f8e3670c6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* ost::StackPager::push </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>string</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Push a string onto the stack. </p>
<dl class="section return"><dt>Returns</dt><dd>stack memory location. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">string</td><td>pointer. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<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></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Oct 17 2013 23:24:57 for GNU CommonC++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
