libdb/docs/api_reference/C/mempset_mp_max_write.html
2011-12-19 19:07:10 -05:00

187 lines
7.5 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?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>DB_ENV-&gt;set_mp_max_write()</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 8.  The DB_MPOOLFILE Handle" />
<link rel="prev" href="mempset_mp_max_openfd.html" title="DB_ENV-&gt;set_mp_max_openfd()" />
<link rel="next" href="envset_mp_mmapsize.html" title="DB_ENV-&gt;set_mp_mmapsize()" />
</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">DB_ENV-&gt;set_mp_max_write()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="mempset_mp_max_openfd.html">Prev</a> </td>
<th width="60%" align="center">Chapter 8. 
The DB_MPOOLFILE Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="envset_mp_mmapsize.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="mempset_mp_max_write"></a>DB_ENV-&gt;set_mp_max_write()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include &lt;db.h&gt;
int
DB_ENV-&gt;set_mp_max_write(DB_ENV *env, int maxwrite,
db_timeout_t maxwrite_sleep); </pre>
<p>
The <code class="methodname">DB_ENV-&gt;set_mp_max_write()</code> method limits the number of sequential
write operations scheduled by the library when flushing dirty pages
from the cache.
</p>
<p>
The database environment's maximum number of sequential write
operations may also be configured using the environment's
<a href="../../programmer_reference/env_db_config.html#env_db_config.DB_CONFIG" class="olink">DB_CONFIG</a> file. The syntax of the entry in that file is a single
line with the string "set_mp_max_write", one or more whitespace
characters, and the maximum number of sequential writes and the
number of microseconds to sleep, also separated by whitespace
characters. Because the <a href="../../programmer_reference/env_db_config.html#env_db_config.DB_CONFIG" class="olink">DB_CONFIG</a> file is read when the database
environment is opened, it will silently overrule configuration
done before that time.
</p>
<p>
The <code class="methodname">DB_ENV-&gt;set_mp_max_write()</code> method configures a database
environment, not only operations performed using the specified
<a class="link" href="env.html" title="Chapter 5.  The DB_ENV Handle">DB_ENV</a> handle.
</p>
<p>
The <code class="methodname">DB_ENV-&gt;set_mp_max_write()</code> <span>
<span>
method returns a non-zero error value on failure and 0 on success.
</span>
</span>
</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id3736186"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id3736193"></a>maxwrite</h4>
</div>
</div>
</div>
<p>
The maximum number of sequential write operations scheduled by the
library when flushing dirty pages from the cache, or 0 if there is no
limitation on the number of sequential write operations.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id3736348"></a>maxwrite_sleep</h4>
</div>
</div>
</div>
<p>
The number of microseconds the thread of control should pause before
scheduling further write operations. It must be specified as an
unsigned 32-bit number of microseconds, limiting the maximum pause to
roughly 71 minutes.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id3736212"></a>Errors</h3>
</div>
</div>
</div>
<p>
The <code class="methodname">DB_ENV-&gt;set_mp_max_write()</code> <span>
<span>
method may fail and return one of the following non-zero errors:
</span>
</span>
</p>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id3736042"></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="id3736040"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="env.html" title="Chapter 5.  The DB_ENV Handle">DB_ENV</a>, <a class="link" href="memp.html" title="Chapter 8.  The DB_MPOOLFILE Handle">DB_MPOOLFILE</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id3736277"></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="mempset_mp_max_openfd.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_mp_mmapsize.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DB_ENV-&gt;set_mp_max_openfd() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DB_ENV-&gt;set_mp_mmapsize()</td>
</tr>
</table>
</div>
</body>
</html>