libdb/docs/api_reference/CXX/memptrickle.html

179 lines
6.6 KiB
HTML
Raw Normal View History

2011-09-13 17:44:24 +00:00
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!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/html; charset=UTF-8" />
<title>DbEnv::memp_trickle()</title>
<link rel="stylesheet" href="apiReference.css" type="text/css" />
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
<link rel="start" href="index.html" title="Berkeley DB C++ API Reference" />
<link rel="up" href="memp.html" title="Chapter 9.  The DbMpoolFile Handle" />
<link rel="prev" href="mempsync.html" title="DbEnv::memp_sync()" />
<link rel="next" href="envset_cache_max.html" title="DbEnv::set_cache_max()" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 11.2.5.2</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">DbEnv::memp_trickle()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="mempsync.html">Prev</a> </td>
<th width="60%" align="center">Chapter 9. 
The DbMpoolFile Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="envset_cache_max.html">Next</a></td>
</tr>
</table>
<hr />
</div>
<div class="sect1" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a id="memptrickle"></a>DbEnv::memp_trickle()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include &lt;db_cxx.h&gt;
int
DbEnv::memp_trickle(int percent, int *nwrotep);</pre>
<p>
The <code class="methodname">DbEnv::memp_trickle()</code> method ensures that a specified percent of
the pages in the cache are clean, by writing dirty pages
to their backing files.
</p>
<p>
The purpose of the <code class="methodname">DbEnv::memp_trickle()</code> function is to enable a
memory pool manager to ensure that a page is always available for
reading in new information without having to wait for a write.
</p>
<p>
The <code class="methodname">DbEnv::memp_trickle()</code> <span>
<span>
method either returns a non-zero error value or throws an
exception that encapsulates a non-zero error value on
failure, and returns 0 on success.
</span>
</span>
</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id3645162"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id3645808"></a>percent</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>percent</strong></span> parameter is the percent
of the pages in the cache that should be clean.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id3645989"></a>nwrotep</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>nwrotep</strong></span> parameter references
memory into which the number of pages written to reach the specified
percentage is copied.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id3645481"></a>Errors</h3>
</div>
</div>
</div>
<p>
The <code class="methodname">DbEnv::memp_trickle()</code> <span>
<span>
method may fail and throw a <a class="link" href="dbexception.html" title="Chapter 6. The DbException Class">DbException</a>
exception, encapsulating one of the following non-zero errors, or return one
of the following non-zero errors:
</span>
</span>
following non-zero errors:
</p>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id3646154"></a>EINVAL</h4>
</div>
</div>
</div>
<p>
An invalid flag value or parameter was specified.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id3645416"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="env.html" title="Chapter 5.  The DbEnv Handle">DbEnv</a>, <a class="link" href="memp.html" title="Chapter 9.  The DbMpoolFile Handle">DbMpoolFile</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id3645919"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="memp.html#memplist" title="Memory Pools and Related Methods">Memory Pools and Related Methods</a>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="mempsync.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="memp.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="envset_cache_max.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DbEnv::memp_sync() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DbEnv::set_cache_max()</td>
</tr>
</table>
</div>
</body>
</html>