← Back to branch summary

~ubuntu-branches/ubuntu/edgy/rpm/edgy

« back to all changes in this revision

Viewing changes to db/docs/api_cxx/env_set_lk_max.html

  • Committer: Bazaar Package Importer
  • Author(s): Joey Hess
  • Date: 2002-01-22 20:56:57 UTC
  • Revision ID: james.westby@ubuntu.com-20020122205657-l74j50mr9z8ofcl5
Tags: upstream-4.0.3
Import upstream version 4.0.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
db/docs/api_cxx/env_set_lk_max.html
 
1
<!--$Id: env_set_lk_max.so,v 10.24 2001/05/15 14:44:10 bostic Exp $-->
 
2
<!--Copyright 1997-2001 by Sleepycat Software, Inc.-->
 
3
<!--All rights reserved.-->
 
4
<html>
 
5
<head>
 
6
<title>Berkeley DB: DbEnv::set_lk_max</title>
 
7
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
 
8
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
 
9
</head>
 
10
<body bgcolor=white>
 
11
<a name="2"><!--meow--></a>
 
12
<table width="100%"><tr valign=top>
 
13
<td>
 
14
<h1>DbEnv::set_lk_max</h1>
 
15
</td>
 
16
<td align=right>
 
17
<a href="../api_cxx/cxx_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
 
18
</td></tr></table>
 
19
<hr size=1 noshade>
 
20
<tt>
 
21
<h3><pre>
 
22
#include &lt;db_cxx.h&gt;
 
23
<p>
 
24
int
 
25
DbEnv::set_lk_max(u_int32_t max);
 
26
</pre></h3>
 
27
<h1>Description</h1>
 
28
<p><b>The DbEnv::set_lk_max method interface has been deprecated in favor of
 
29
the <a href="../api_cxx/env_set_lk_max_locks.html">DbEnv::set_lk_max_locks</a>, <a href="../api_cxx/env_set_lk_max_lockers.html">DbEnv::set_lk_max_lockers</a>,
 
30
and <a href="../api_cxx/env_set_lk_max_objects.html">DbEnv::set_lk_max_objects</a> methods.  Please update your applications.</b>
 
31
<p>Set each of the maximum number of locks, lockers, and lock objects
 
32
supported by the Berkeley DB lock subsystem to <b>max</b>.  This value is
 
33
used by <a href="../api_cxx/env_open.html">DbEnv::open</a> to estimate how much space to allocate for
 
34
various lock-table data structures.  For specific information on
 
35
configuring the size of the lock subsystem, see
 
36
<a href="../ref/lock/max.html">Configuring locking:  sizing the
 
37
system</a>.
 
38
<p>The DbEnv::set_lk_max interface may be used only to configure Berkeley DB before
 
39
the <a href="../api_cxx/env_open.html">DbEnv::open</a> interface is called.
 
40
<p>The DbEnv::set_lk_max method either returns a non-zero error value or throws an exception that
 
41
encapsulates a non-zero error value on failure, and returns 0 on success.
 
42
<p>The database environment's maximum number of locks may also be set using the environment's
 
43
<b>DB_CONFIG</b> file.  The syntax of the entry in that file is a
 
44
single line with the string "set_lk_max", one or more whitespace characters,
 
45
and the number of locks.  Because the <b>DB_CONFIG</b> file is read when the database
 
46
environment is opened, it will silently overrule configuration done
 
47
before that time.
 
48
<h1>Errors</h1>
 
49
<p>The DbEnv::set_lk_max method may fail and throw an exception or return a non-zero error for the following conditions:
 
50
<p><dl compact>
 
51
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
 
52
<p>Called after <a href="../api_cxx/env_open.html">DbEnv::open</a> was called.
 
53
</dl>
 
54
<p>The DbEnv::set_lk_max method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods.
 
55
If a catastrophic error has occurred, the DbEnv::set_lk_max method may fail and either
 
56
return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating
 
57
<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail
 
58
in the same way.
 
59
<h1>Class</h1>
 
60
<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/lock_class.html">DbLock</a>
 
61
<h1>See Also</h1>
 
62
<a href="../api_cxx/env_set_lk_conflicts.html">DbEnv::set_lk_conflicts</a>,
 
63
<a href="../api_cxx/env_set_lk_detect.html">DbEnv::set_lk_detect</a>,
 
64
<a href="../api_cxx/env_set_lk_max.html">DbEnv::set_lk_max</a>,
 
65
<a href="../api_cxx/env_set_lk_max_lockers.html">DbEnv::set_lk_max_lockers</a>,
 
66
<a href="../api_cxx/env_set_lk_max_locks.html">DbEnv::set_lk_max_locks</a>,
 
67
<a href="../api_cxx/env_set_lk_max_objects.html">DbEnv::set_lk_max_objects</a>,
 
68
<a href="../api_cxx/lock_detect.html">DbEnv::lock_detect</a>,
 
69
<a href="../api_cxx/lock_get.html">DbEnv::lock_get</a>,
 
70
<a href="../api_cxx/lock_id.html">DbEnv::lock_id</a>,
 
71
<a href="../api_cxx/lock_put.html">DbLock::put</a>,
 
72
<a href="../api_cxx/lock_stat.html">DbEnv::lock_stat</a>,
 
73
and
 
74
<a href="../api_cxx/lock_vec.html">DbEnv::lock_vec</a>.
 
75
</tt>
 
76
<table width="100%"><tr><td><br></td><td align=right>
 
77
<a href="../api_cxx/cxx_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
 
78
</td></tr></table>
 
79
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
 
80
</body>
 
81
</html>