~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

Viewing changes to libdb/docs/api_c/lock_stat.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<!--$Id$-->
2
 
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
3
 
<!--All rights reserved.-->
4
 
<!--See the file LICENSE for redistribution information.-->
5
 
<html>
6
 
<head>
7
 
<title>Berkeley DB: DB_ENV-&gt;lock_stat</title>
8
 
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
9
 
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
10
 
</head>
11
 
<body bgcolor=white>
12
 
<a name="2"><!--meow--></a>
13
 
<table width="100%"><tr valign=top>
14
 
<td>
15
 
<h1>DB_ENV-&gt;lock_stat</h1>
16
 
</td>
17
 
<td align=right>
18
 
<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
19
 
</td></tr></table>
20
 
<hr size=1 noshade>
21
 
<tt>
22
 
<h3><pre>
23
 
#include &lt;db.h&gt;
24
 
<p>
25
 
int
26
 
DB_ENV-&gt;lock_stat(DB_ENV *env, DB_LOCK_STAT **statp, u_int32_t flags);
27
 
</pre></h3>
28
 
<h1>Description</h1>
29
 
<p>The DB_ENV-&gt;lock_stat method returns the locking subsystem statistics.
30
 
<p>The <b>flags</b> value must be set to 0 or
31
 
the following value:
32
 
<p><dl compact>
33
 
<p><dt><a name="DB_STAT_CLEAR">DB_STAT_CLEAR</a><dd>Reset statistics after returning their values.
34
 
</dl>
35
 
<p>The DB_ENV-&gt;lock_stat method creates a statistical structure of type
36
 
DB_LOCK_STAT and copies a pointer to it into a user-specified memory
37
 
location.
38
 
<p>Statistical structures are created in allocated memory.  If application-specific allocation
39
 
routines have been declared (see <a href="../api_c/env_set_alloc.html">DB_ENV-&gt;set_alloc</a> for more
40
 
information), they are used to allocate the memory; otherwise, the
41
 
library <b>malloc</b>(3) interface is used.  The caller is
42
 
responsible for deallocating the memory.  To deallocate the memory, free
43
 
the memory reference; references inside the returned memory need not be
44
 
individually freed.
45
 
<p>The following DB_LOCK_STAT fields will be filled in:
46
 
<p><dl compact>
47
 
<dt>u_int32_t st_id;<dd>The last allocated locker ID.
48
 
<dt>u_int32_t st_cur_maxid;<dd>The current maximum unused locker ID.
49
 
<dt>u_int32_t st_nmodes;<dd>The number of lock modes.
50
 
<dt>u_int32_t st_maxlocks;<dd>The maximum number of locks possible.
51
 
<dt>u_int32_t st_maxlockers;<dd>The maximum number of lockers possible.
52
 
<dt>u_int32_t st_maxobjects;<dd>The maximum number of lock objects possible.
53
 
<dt>u_int32_t st_nlocks;<dd>The number of current locks.
54
 
<dt>u_int32_t st_maxnlocks;<dd>The maximum number of locks at any one time.
55
 
<dt>u_int32_t st_nlockers;<dd>The number of current lockers.
56
 
<dt>u_int32_t st_maxnlockers;<dd>The maximum number of lockers at any one time.
57
 
<dt>u_int32_t st_nobjects;<dd>The number of current lock objects.
58
 
<dt>u_int32_t st_maxnobjects;<dd>The maximum number of lock objects at any one time.
59
 
<dt>u_int32_t st_nrequests;<dd>The total number of locks requested.
60
 
<dt>u_int32_t st_nreleases;<dd>The total number of locks released.
61
 
<dt>u_int32_t st_nnowaits;<dd>The total number of lock requests failing because
62
 
<a href="../api_c/lock_vec.html#DB_LOCK_NOWAIT">DB_LOCK_NOWAIT</a> was set.
63
 
<dt>u_int32_t st_nconflicts;<dd>The total number of locks not immediately available due to conflicts.
64
 
<dt>u_int32_t st_ndeadlocks;<dd>The number of deadlocks.
65
 
<dt>u_int32_t st_locktimeout;<dd>Lock timeout value.
66
 
<dt>u_int32_t st_nlocktimeouts;<dd>The number of locks that have timed out.
67
 
<dt>u_int32_t st_txntimeout;<dd>Transaction timeout value.
68
 
<dt>u_int32_t st_ntxntimeouts;<dd>The number of transactions that have timed out.  This value is also a
69
 
component of <b>st_ndeadlocks</b>, the total number of deadlocks
70
 
detected.
71
 
<dt>u_int32_t st_regsize;<dd>The size of the lock region.
72
 
<dt>u_int32_t st_region_wait;<dd>The number of times that a thread of control was forced to wait before
73
 
obtaining the region lock.
74
 
<dt>u_int32_t st_region_nowait;<dd>The number of times that a thread of control was able to obtain
75
 
the region lock without waiting.
76
 
</dl>
77
 
<p>The DB_ENV-&gt;lock_stat method returns a non-zero error value on failure and 0 on success.
78
 
<h1>Errors</h1>
79
 
<p>The DB_ENV-&gt;lock_stat method may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions.
80
 
If a catastrophic error has occurred, the DB_ENV-&gt;lock_stat method may fail and
81
 
return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>,
82
 
in which case all subsequent Berkeley DB calls will fail in the same way.
83
 
<h1>Class</h1>
84
 
<a href="../api_c/env_class.html">DB_ENV</a>, <a href="../api_c/lock_class.html">DB_LOCK</a>
85
 
<h1>See Also</h1>
86
 
<a href="../api_c/lock_list.html">Locking Subsystem and Related Methods</a>
87
 
</tt>
88
 
<table width="100%"><tr><td><br></td><td align=right>
89
 
<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
90
 
</td></tr></table>
91
 
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
92
 
</body>
93
 
</html>