lock_stat.html   [plain text]


<!--$Id: lock_stat.html,v 1.1 2003/02/15 04:55:53 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.lock_stat</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.lock_stat</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 DbLockStat lock_stat(int flags)
    throws DbException;
</pre></h3>
<h1>Description</h1>
<p>The DbEnv.lock_stat method returns the locking subsystem statistics.
<p>The <b>flags</b> value must be set to 0 or
the following value:
<p><dl compact>
<p><dt><a name="Db.DB_STAT_CLEAR">Db.DB_STAT_CLEAR</a><dd>Reset statistics after returning their values.
</dl>
<p>The DbEnv.lock_stat method creates a DbLockStat object encapsulating the
lock region statistics.  The following data fields are available from
the DbLockStat object:
<p><dl compact>
<dt>public int st_id;<dd>The last allocated locker ID.
<dt>public int st_cur_maxid;<dd>The current maximum unused locker ID.
<dt>public int st_nmodes;<dd>The number of lock modes.
<dt>public int st_maxlocks;<dd>The maximum number of locks possible.
<dt>public int st_maxlockers;<dd>The maximum number of lockers possible.
<dt>public int st_maxobjects;<dd>The maximum number of lock objects possible.
<dt>public int st_nlocks;<dd>The number of current locks.
<dt>public int st_maxnlocks;<dd>The maximum number of locks at any one time.
<dt>public int st_nlockers;<dd>The number of current lockers.
<dt>public int st_maxnlockers;<dd>The maximum number of lockers at any one time.
<dt>public int st_nobjects;<dd>The number of current lock objects.
<dt>public int st_maxnobjects;<dd>The maximum number of lock objects at any one time.
<dt>public int st_nrequests;<dd>The total number of locks requested.
<dt>public int st_nreleases;<dd>The total number of locks released.
<dt>public int st_nnowaits;<dd>The total number of lock requests failing because
<a href="../api_java/lock_vec.html#DB_LOCK_NOWAIT">Db.DB_LOCK_NOWAIT</a> was set.
<dt>public int st_nconflicts;<dd>The total number of locks not immediately available due to conflicts.
<dt>public int st_ndeadlocks;<dd>The number of deadlocks.
<dt>public int st_locktimeout;<dd>Lock timeout value.
<dt>public int st_nlocktimeouts;<dd>The number of locks that have timed out.
<dt>public int st_txntimeout;<dd>Transaction timeout value.
<dt>public int st_ntxntimeouts;<dd>The number of transactions that have timed out.  This value is also a
component of <b>st_ndeadlocks</b>, the total number of deadlocks
detected.
<dt>public int st_regsize;<dd>The size of the lock region.
<dt>public int st_region_wait;<dd>The number of times that a thread of control was forced to wait before
obtaining the region lock.
<dt>public int st_region_nowait;<dd>The number of times that a thread of control was able to obtain
the region lock without waiting.
</dl>
<p>The DbEnv.lock_stat method throws an exception that encapsulates a non-zero error value on
failure.
<h1>Errors</h1>
<p>The DbEnv.lock_stat 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.lock_stat 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>