<!--$Id: lock_stat.so,v 10.43 2002/08/18 21:16:37 bostic 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="../../db4-devel-4.1.25/api_cxx/c_index.html"><img src="../../db4-4.1.25/images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../../db4-4.1.25/images/ref.gif" alt="Ref"></a> </td></tr></table> <hr size=1 noshade> <tt> <h3><pre> #include <db_cxx.h> <p> int DbEnv::lock_stat(DB_LOCK_STAT **statp, u_int32_t flags); </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_STAT_CLEAR">DB_STAT_CLEAR</a><dd>Reset statistics after returning their values. </dl> <p>The DbEnv::lock_stat method creates a statistical structure of type DB_LOCK_STAT and copies a pointer to it into a user-specified memory location. <p>Statistical structures are created in allocated memory. If application-specific allocation routines have been declared (see <a href="../../db4-devel-4.1.25/api_cxx/env_set_alloc.html">DbEnv::set_alloc</a> for more information), they are used to allocate the memory; otherwise, the library <b>malloc</b>(3) interface is used. The caller is responsible for deallocating the memory. To deallocate the memory, free the memory reference; references inside the returned memory need not be individually freed. <p>The following DB_LOCK_STAT fields will be filled in: <p><dl compact> <dt>u_int32_t st_id;<dd>The last allocated locker ID. <dt>u_int32_t st_cur_maxid;<dd>The current maximum unused locker ID. <dt>u_int32_t st_nmodes;<dd>The number of lock modes. <dt>u_int32_t st_maxlocks;<dd>The maximum number of locks possible. <dt>u_int32_t st_maxlockers;<dd>The maximum number of lockers possible. <dt>u_int32_t st_maxobjects;<dd>The maximum number of lock objects possible. <dt>u_int32_t st_nlocks;<dd>The number of current locks. <dt>u_int32_t st_maxnlocks;<dd>The maximum number of locks at any one time. <dt>u_int32_t st_nlockers;<dd>The number of current lockers. <dt>u_int32_t st_maxnlockers;<dd>The maximum number of lockers at any one time. <dt>u_int32_t st_nobjects;<dd>The number of current lock objects. <dt>u_int32_t st_maxnobjects;<dd>The maximum number of lock objects at any one time. <dt>u_int32_t st_nrequests;<dd>The total number of locks requested. <dt>u_int32_t st_nreleases;<dd>The total number of locks released. <dt>u_int32_t st_nnowaits;<dd>The total number of lock requests failing because <a href="../../db4-devel-4.1.25/api_cxx/lock_vec.html#DB_LOCK_NOWAIT">DB_LOCK_NOWAIT</a> was set. <dt>u_int32_t st_nconflicts;<dd>The total number of locks not immediately available due to conflicts. <dt>u_int32_t st_ndeadlocks;<dd>The number of deadlocks. <dt>u_int32_t st_locktimeout;<dd>Lock timeout value. <dt>u_int32_t st_nlocktimeouts;<dd>The number of locks that have timed out. <dt>u_int32_t st_txntimeout;<dd>Transaction timeout value. <dt>u_int32_t 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>u_int32_t st_regsize;<dd>The size of the lock region. <dt>u_int32_t st_region_wait;<dd>The number of times that a thread of control was forced to wait before obtaining the region lock. <dt>u_int32_t 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 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. <h1>Errors</h1> <p>The DbEnv::lock_stat 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. If a catastrophic error has occurred, the DbEnv::lock_stat method may fail and either return <a href="../../db4-devel-4.1.25/ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a <a href="../../db4-devel-4.1.25/api_cxx/runrec_class.html">DbRunRecoveryException</a>, in which case all subsequent Berkeley DB calls will fail in the same way. <h1>Class</h1> <a href="../../db4-devel-4.1.25/api_cxx/env_class.html">DbEnv</a>, <a href="../../db4-devel-4.1.25/api_cxx/lock_class.html">DbLock</a> <h1>See Also</h1> <a href="../../db4-devel-4.1.25/api_cxx/lock_list.html">Locking Subsystem and Related Methods</a> </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../../db4-devel-4.1.25/api_cxx/c_index.html"><img src="../../db4-4.1.25/images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../../db4-4.1.25/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>