← Back to branch summary

~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

Viewing changes to libdb/docs/api_c/memp_trickle.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.10.5 upstream)
  • mto: This revision was merged to the branch mainline in revision 128.
  • Revision ID: james.westby@ubuntu.com-20100517170206-xu1wmjuy40nt2sk0
Tags: upstream-2.30.1
Import upstream version 2.30.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
libdb/docs/api_c/memp_trickle.html
1
 
<!--$Id$-->
2
 
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
3
 
<!--All rights reserved.-->
4
 
<!--See the file LICENSE for redistribution information.-->
5
 
<html>
6
 
<head>
7
 
<title>Berkeley DB: DB_ENV-&gt;memp_trickle</title>
8
 
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
9
 
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
10
 
</head>
11
 
<body bgcolor=white>
12
 
<a name="2"><!--meow--></a>
13
 
<table width="100%"><tr valign=top>
14
 
<td>
15
 
<h1>DB_ENV-&gt;memp_trickle</h1>
16
 
</td>
17
 
<td align=right>
18
 
<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
19
 
</td></tr></table>
20
 
<hr size=1 noshade>
21
 
<tt>
22
 
<h3><pre>
23
 
#include &lt;db.h&gt;
24
 
<p>
25
 
int
26
 
DB_ENV-&gt;memp_trickle(DB_ENV *env, int pct, int *nwrotep);
27
 
</pre></h3>
28
 
<h1>Description</h1>
29
 
<p>The DB_ENV-&gt;memp_trickle method ensures that at least <b>pct</b> percent of
30
 
the pages in the shared memory pool are clean by writing dirty pages to
31
 
their backing files.
32
 
If the <b>nwrotep</b> argument is non-NULL, the number of pages that
33
 
were written to reach the correct percentage is returned in the memory
34
 
location to which it refers.
35
 
<p>The purpose of the DB_ENV-&gt;memp_trickle function is to enable a memory
36
 
pool manager to ensure that a page is always available for reading in new
37
 
information without having to wait for a write.
38
 
<p>The DB_ENV-&gt;memp_trickle method returns a non-zero error value on failure and 0 on success.
39
 
<h1>Errors</h1>
40
 
<p>The DB_ENV-&gt;memp_trickle method may fail and return a non-zero error for the following conditions:
41
 
<p><dl compact>
42
 
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
43
 
</dl>
44
 
<p>The DB_ENV-&gt;memp_trickle method may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions.
45
 
If a catastrophic error has occurred, the DB_ENV-&gt;memp_trickle method may fail and
46
 
return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>,
47
 
in which case all subsequent Berkeley DB calls will fail in the same way.
48
 
<h1>Class</h1>
49
 
<a href="../api_c/env_class.html">DB_ENV</a>, <a href="../api_c/mempfile_class.html">DB_MPOOLFILE</a>
50
 
<h1>See Also</h1>
51
 
<a href="../api_c/memp_list.html">Memory Pools and Related Methods</a>
52
 
</tt>
53
 
<table width="100%"><tr><td><br></td><td align=right>
54
 
<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
55
 
</td></tr></table>
56
 
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
57
 
</body>
58
 
</html>