1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
<?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::mutex_set_increment()</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="mutex.html" title="Chapter 10. Mutex Methods" />
<link rel="prev" href="mutexset_align.html" title="DbEnv::mutex_set_align()" />
<link rel="next" href="mutexset_init.html" title="DbEnv::mutex_set_init()" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 11.2.5.3</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">DbEnv::mutex_set_increment()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="mutexset_align.html">Prev</a> </td>
<th width="60%" align="center">Chapter 10.
Mutex Methods
</th>
<td width="20%" align="right"> <a accesskey="n" href="mutexset_init.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="mutexset_increment"></a>DbEnv::mutex_set_increment()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db_cxx.h>
int
DbEnv::mutex_set_increment(u_int32_t increment); </pre>
<p>
Configure the number of additional mutexes to allocate.
</p>
<p>
If an application will allocate mutexes for its own use,
the <code class="methodname">DbEnv::mutex_set_increment()</code> method is used to add a
number of mutexes to the default allocation.
</p>
<p>
Calling the <code class="methodname">DbEnv::mutex_set_increment()</code> method discards any value
previously set using the <a class="xref" href="mutexset_max.html" title="DbEnv::mutex_set_max()">DbEnv::mutex_set_max()</a> method.
</p>
<p>
The database environment's number of additional mutexes 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
"mutex_set_increment", one or more whitespace characters, and the
number of additional mutexes. 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">DbEnv::mutex_set_increment()</code> method configures a database
environment, not only operations performed using the specified
<a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a> handle.
</p>
<p>
The <code class="methodname">DbEnv::mutex_set_increment()</code> method may not be called after the
<a class="xref" href="envopen.html" title="DbEnv::open()">DbEnv::open()</a> method is
called. If the database environment already exists when
<a class="xref" href="envopen.html" title="DbEnv::open()">DbEnv::open()</a> is called, the
information specified to <code class="methodname">DbEnv::mutex_set_increment()</code> will be
ignored.
</p>
<p>
The <code class="methodname">DbEnv::mutex_set_increment()</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="idp9214576"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp9213928"></a>increment</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>increment</strong></span> parameter is the number
of additional mutexes to allocate.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp9203048"></a>Errors</h3>
</div>
</div>
</div>
<p>
The <code class="methodname">DbEnv::mutex_set_increment()</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>
</p>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp9223872"></a>EINVAL</h4>
</div>
</div>
</div>
<p>
If the method was called after <a class="xref" href="envopen.html" title="DbEnv::open()">DbEnv::open()</a>
was called; or if 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="idp9225200"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp9215440"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="mutex.html#mutexlist" title="Mutex Methods">Mutex 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="mutexset_align.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="mutex.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="mutexset_init.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DbEnv::mutex_set_align() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DbEnv::mutex_set_init()</td>
</tr>
</table>
</div>
</body>
</html>
|
