<!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::SharedMemPager 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_shared_mem_pager.html">SharedMemPager</a></div>
<h1>ost::SharedMemPager Class Reference</h1><!-- doxytag: class="ost::SharedMemPager" --><!-- doxytag: inherits="ost::MemPager,ost::Mutex" -->The shared mempager uses a mutex to protect key access methods.mutex protected memory 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::SharedMemPager:
<p><center><img src="classost_1_1_shared_mem_pager.png" usemap="#ost::SharedMemPager_map" border="0" alt=""></center>
<map name="ost::SharedMemPager_map">
<area href="classost_1_1_mem_pager.html" alt="ost::MemPager" shape="rect" coords="0,0,136,24">
<area href="classost_1_1_mutex.html" alt="ost::Mutex" shape="rect" coords="146,0,282,24">
</map>
<a href="classost_1_1_shared_mem_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>Protected 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_shared_mem_pager.html#6914e160b526068c31c0086134cbfbac">SharedMemPager</a> (size_t pagesize=4096, const char *name=NULL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a mempager mutex pool. <a href="#6914e160b526068c31c0086134cbfbac"></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_shared_mem_pager.html#fafb0b8ce31a2b1fdee64a5a9cadebc6">purge</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Purge the memory pool while locked. <a href="#fafb0b8ce31a2b1fdee64a5a9cadebc6"></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_shared_mem_pager.html#644a00d48052aff83a180523b205aa6f">first</a> (size_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the first memory page after locking. <a href="#644a00d48052aff83a180523b205aa6f"></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_shared_mem_pager.html#d5c3aad294fd247a972a72983dcf831b">alloc</a> (size_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the last memory page after locking. <a href="#d5c3aad294fd247a972a72983dcf831b"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The shared mempager uses a mutex to protect key access methods.mutex protected memory pager.
<p>
This class is used when a mempager will be shared by multiple threads.<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="6914e160b526068c31c0086134cbfbac"></a><!-- doxytag: member="ost::SharedMemPager::SharedMemPager" ref="6914e160b526068c31c0086134cbfbac" args="(size_t pagesize=4096, const char *name=NULL)" --><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::SharedMemPager::SharedMemPager </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">size_t </td>
<td class="mdname" nowrap> <em>pagesize</em> = <code>4096</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>name</em> = <code>NULL</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Create a mempager mutex pool.
<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>page size for allocation. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>a name for the pool. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d5c3aad294fd247a972a72983dcf831b"></a><!-- doxytag: member="ost::SharedMemPager::alloc" ref="d5c3aad294fd247a972a72983dcf831b" args="(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::SharedMemPager::alloc </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">size_t </td>
<td class="mdname1" valign="top" nowrap> <em>size</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the last memory page after locking.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>allocated memory space. </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>size</em> </td><td>of request. </td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="classost_1_1_mem_pager.html#3a03cb50bd4084ddbf6314ec0339d176">ost::MemPager</a>. </td>
</tr>
</table>
<a class="anchor" name="644a00d48052aff83a180523b205aa6f"></a><!-- doxytag: member="ost::SharedMemPager::first" ref="644a00d48052aff83a180523b205aa6f" args="(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::SharedMemPager::first </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">size_t </td>
<td class="mdname1" valign="top" nowrap> <em>size</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the first memory page after locking.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>allocated memory space. </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>size</em> </td><td>of request. </td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="classost_1_1_mem_pager.html#2c82ac4c97fcba81c643966973e78d84">ost::MemPager</a>. </td>
</tr>
</table>
<a class="anchor" name="fafb0b8ce31a2b1fdee64a5a9cadebc6"></a><!-- doxytag: member="ost::SharedMemPager::purge" ref="fafb0b8ce31a2b1fdee64a5a9cadebc6" 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::SharedMemPager::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><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Purge the memory pool while locked.
<p>
<p>
Reimplemented from <a class="el" href="classost_1_1_mem_pager.html#5bfdb6f2d6f569ba08c32c59efb3a012">ost::MemPager</a>. </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>
