<!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: ucommon::bufpager Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.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 class="tabs">
<ul>
<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="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="a00208.html">ucommon</a>::<a class="el" href="a00029.html">bufpager</a>
</div>
</div>
<div class="contents">
<h1>ucommon::bufpager Class Reference</h1><!-- doxytag: class="ucommon::bufpager" --><!-- doxytag: inherits="ucommon::memalloc,ucommon::CharacterProtocol" -->
<p>Buffered pager for storing paged strings for character protocol.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00190_source.html">memory.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucommon::bufpager:</div>
<div class="dynsection">
<div class="center"><img src="a00350.png" border="0" usemap="#ucommon_1_1bufpager_inherit__map" alt="Inheritance graph"/></div>
<map name="ucommon_1_1bufpager_inherit__map" id="ucommon_1_1bufpager_inherit__map">
<area shape="rect" id="node2" href="a00079.html" title="A memory protocol pager for private heap manager." alt="" coords="40,80,232,107"/><area shape="rect" id="node4" href="a00073.html" title="Common locking protocol." alt="" coords="5,5,267,32"/><area shape="rect" id="node6" href="a00030.html" title="Common character processing protocol." alt="" coords="256,80,539,107"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucommon::bufpager:</div>
<div class="dynsection">
<div class="center"><img src="a00351.png" border="0" usemap="#ucommon_1_1bufpager_coll__map" alt="Collaboration graph"/></div>
<map name="ucommon_1_1bufpager_coll__map" id="ucommon_1_1bufpager_coll__map">
<area shape="rect" id="node2" href="a00079.html" title="A memory protocol pager for private heap manager." alt="" coords="40,80,232,107"/><area shape="rect" id="node4" href="a00073.html" title="Common locking protocol." alt="" coords="5,5,267,32"/><area shape="rect" id="node6" href="a00030.html" title="Common character processing protocol." alt="" coords="256,80,539,107"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aebb36957fdce5bc5507e8d29315b529d"></a><!-- doxytag: member="ucommon::bufpager::bufpager" ref="aebb36957fdce5bc5507e8d29315b529d" args="(size_t page=0)" -->
</td><td class="memItemRight" valign="bottom"><b>bufpager</b> (size_t page=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#a1b143b529ab6e77c323781b8370704ce">getUsed</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get total size. <a href="#a1b143b529ab6e77c323781b8370704ce"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad6a30dbb420a940b64395f10fa7a8d30"></a><!-- doxytag: member="ucommon::bufpager::reset" ref="ad6a30dbb420a940b64395f10fa7a8d30" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#ad6a30dbb420a940b64395f10fa7a8d30">reset</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset pager text buffer protocol. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a55bfa74d78876ae060cb312a52030c13"></a><!-- doxytag: member="ucommon::bufpager::rewind" ref="a55bfa74d78876ae060cb312a52030c13" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#a55bfa74d78876ae060cb312a52030c13">rewind</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Rewind to start of text buffer protocol. <br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#ab3992dc389aa06e5c2f04fcb6ca1fb84">_alloc</a> (size_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocate memory from the pager heap. <a href="#ab3992dc389aa06e5c2f04fcb6ca1fb84"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Buffered pager for storing paged strings for character protocol. </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="a00190_source.html#l00238">238</a> of file <a class="el" href="a00190_source.html">memory.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab3992dc389aa06e5c2f04fcb6ca1fb84"></a><!-- doxytag: member="ucommon::bufpager::_alloc" ref="ab3992dc389aa06e5c2f04fcb6ca1fb84" args="(size_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void* ucommon::bufpager::_alloc </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>size</em></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Allocate memory from the pager heap. </p>
<p>The size of the request must be less than the size of the memory page used. This implements the memory protocol allocation method. </p>
<dl><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 memory request. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>allocated memory or NULL if not possible. </dd></dl>
<p>Reimplemented from <a class="el" href="a00079.html#ae9a8e8784c11ce95a0e4d88ca5ce992a">ucommon::memalloc</a>.</p>
</div>
</div>
<a class="anchor" id="a1b143b529ab6e77c323781b8370704ce"></a><!-- doxytag: member="ucommon::bufpager::getUsed" ref="a1b143b529ab6e77c323781b8370704ce" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long ucommon::bufpager::getUsed </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get total size. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of characters in buffer. </dd></dl>
<p>Definition at line <a class="el" href="a00190_source.html#l00272">272</a> of file <a class="el" href="a00190_source.html">memory.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00190_source.html">memory.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Jul 14 16:39:30 2011 for ucommon by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.2
>
i586
>
media
>
contrib-backports
>
by-pkgid
>
4f5f2dc0f55b453456458df885792b0b
>
files
>
55
