env_set_lk_max_lockers.html [plain text]
<!--$Id: env_set_lk_max_lockers.html,v 1.1.1.1 2003/02/15 04:55:52 zarzycki Exp $-->
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DbEnv.set_lk_max_lockers</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
</head>
<body bgcolor=white>
<a name="2"><!--meow--></a>
<table width="100%"><tr valign=top>
<td>
<h1>DbEnv.set_lk_max_lockers</h1>
</td>
<td align=right>
<a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<hr size=1 noshade>
<tt>
<h3><pre>
import com.sleepycat.db.*;
<p>
public void set_lk_max_lockers(int max)
throws DbException;
</pre></h3>
<h1>Description</h1>
<p>Set the maximum number of simultaneous locking entities supported by
the Berkeley DB lock subsystem. This value is used by <a href="../api_java/env_open.html">DbEnv.open</a> to
estimate how much space to allocate for various lock-table data
structures. The default value is 1000 lockers. For specific
information on configuring the size of the lock subsystem, see
<a href="../ref/lock/max.html">Configuring locking: sizing the
system</a>.
<p>The DbEnv.set_lk_max_lockers method configures a database environment, not only operations
performed using the specified <a href="../api_java/env_class.html">DbEnv</a> handle.
<p>The DbEnv.set_lk_max_lockers interface may not be called after the <a href="../api_java/env_open.html">DbEnv.open</a>
interface is called.
If the database environment already exists when
<a href="../api_java/env_open.html">DbEnv.open</a> is called, the information specified to DbEnv.set_lk_max_lockers
will be ignored.
<p>The DbEnv.set_lk_max_lockers method throws an exception that encapsulates a non-zero error value on
failure.
<p>The database environment's maximum number of lockers may also be set using the environment's
<b>DB_CONFIG</b> file. The syntax of the entry in that file is a
single line with the string "set_lk_max_lockers", one or more whitespace characters,
and the number of lockers. Because the <b>DB_CONFIG</b> file is read when the database
environment is opened, it will silently overrule configuration done
before that time.
<h1>Errors</h1>
<p>The DbEnv.set_lk_max_lockers method may fail and throw an exception encapsulating a non-zero error for the following conditions:
<p><dl compact>
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
<p>Called after <a href="../api_java/env_open.html">DbEnv.open</a> was called.
</dl>
<p>The DbEnv.set_lk_max_lockers method may fail and throw an exception for errors specified for other Berkeley DB and C library or system methods.
If a catastrophic error has occurred, the DbEnv.set_lk_max_lockers method may fail and
throw a <a href="../api_java/runrec_class.html">DbRunRecoveryException</a>,
in which case all subsequent Berkeley DB calls will fail in the same way.
<h1>Class</h1>
<a href="../api_java/env_class.html">DbEnv</a>, <a href="../api_java/lock_class.html">DbLock</a>
<h1>See Also</h1>
<a href="../api_java/lock_list.html">Locking Subsystem and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
</body>
</html>