Sophie

Sophie

distrib > Mandriva > 2007.0 > x86_64 > media > main-release > by-pkgid > a4c98df40e78f6c892308fd6841f950a > files > 370

lib64db4.2-devel-4.2.52-11mdv2007.0.x86_64.rpm

<!--$Id: txn_stat.so,v 10.55 2003/11/27 02:15:22 bostic Exp $-->
<!--Copyright 1997-2003 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DbEnv::txn_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>
<h3>DbEnv::txn_stat</h3>
</td>
<td align=right>
<a href="../../db42-devel-4.2.52/api_cxx/api_index.html"><img src="../../db42-4.2.52/images/api.gif" alt="API"></a>
<a href="../../db42-devel-4.2.52/ref/toc.html"><img src="../../db42-4.2.52/images/ref.gif" alt="Ref"></a>
</td></tr></table>
<hr size=1 noshade>
<tt>
<h3><pre>
#include &lt;db_cxx.h&gt;
<p>
int
DbEnv::txn_stat(DB_TXN_STAT **statp, u_int32_t flags);
</pre></h3>
<hr size=1 noshade>
<h3>Description: DbEnv::txn_stat</h3>
<p>The DbEnv::txn_stat method returns the transaction subsystem statistics.</p>
<p>The DbEnv::txn_stat method creates a statistical structure of type
DB_TXN_STAT and copies a pointer to it into a user-specified memory
location.</p>
<p>Statistical structures are stored in allocated memory.  If application-specific allocation
routines have been declared (see <a href="../../db42-devel-4.2.52/api_cxx/env_set_alloc.html">DbEnv::set_alloc</a> for more
information), they are used to allocate the memory; otherwise, the
standard C library <b>malloc</b>(3) 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>
<p>The following DB_TXN_STAT fields will be filled in:</p>
<p><dl compact>
<dt>DbLsn st_last_ckp;<dd>The LSN of the last checkpoint.
<dt>time_t st_time_ckp;<dd>The time the last completed checkpoint finished (as the number of seconds
since the Epoch, returned by the IEEE/ANSI Std 1003.1 (POSIX) <b>time</b> function).
<dt>u_int32_t st_last_txnid;<dd>The last transaction ID allocated.
<dt>u_int32_t st_maxtxns;<dd>The maximum number of active transactions configured.
<dt>u_int32_t st_nactive;<dd>The number of transactions that are currently active.
<dt>u_int32_t st_maxnactive;<dd>The maximum number of active transactions at any one time.
<dt>u_int32_t st_nbegins;<dd>The number of transactions that have begun.
<dt>u_int32_t st_naborts;<dd>The number of transactions that have aborted.
<dt>u_int32_t st_ncommits;<dd>The number of transactions that have committed.
<dt>u_int32_t st_nrestores;<dd>The number of transactions that have been restored.
<dt>u_int32_t st_regsize;<dd>The size of the 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.
<dt>DB_TXN_ACTIVE *st_txnarray;<dd>A pointer to an array of <b>st_nactive</b> DB_TXN_ACTIVE structures,
describing the currently active transactions.  The following fields of
the DB_TXN_ACTIVE structure will be filled in:
<p><dl compact>
<dt>u_int32_t txnid;<dd>The transaction ID of the transaction.
<dt>u_int32_t parentid;<dd>The transaction ID of the parent transaction (or 0, if no parent).
<dt>DbLsn lsn;<dd>The current log sequence number when the transaction was begun.
<dt>u_int32_t xa_status;<dd>If the transaction is an XA transaction, the status of the transaction,
otherwise 0.
<dt>u_int8_t xid[DB_XIDDATASIZE];<dd>If the transaction is an XA transaction, the transaction's XA ID.
</dl>
</dl>
<p>The DbEnv::txn_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.
</p>
<h3>Parameters</h3>
<p><dl compact>
<p><dt><b>flags</b><dd>
The <b>flags</b> parameter 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><dt><b>statp</b><dd>
The <b>statp</b> parameter references memory into which
a pointer to the allocated statistics structure is copied.
</dl>
<h3>Errors</h3>
<p>The DbEnv::txn_stat method
may fail and throw
<a href="../../db42-devel-4.2.52/api_cxx/except_class.html">DbException</a>,
encapsulating one of the following non-zero errors, or return one of
the following non-zero errors:</p>
<p><dl compact>
<p><dt>EINVAL<dd>An
invalid flag value or parameter was specified.
</dl>
<hr size=1 noshade>
<h3>Class</h3>
<a href="../../db42-devel-4.2.52/api_cxx/env_class.html">DbEnv</a>, <a href="../../db42-devel-4.2.52/api_cxx/txn_class.html">DbTxn</a>
<h3>See Also</h3>
<a href="../../db42-devel-4.2.52/api_cxx/txn_list.html">Transaction Subsystem and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../../db42-devel-4.2.52/api_cxx/api_index.html"><img src="../../db42-4.2.52/images/api.gif" alt="API"></a><a href="../../db42-devel-4.2.52/ref/toc.html"><img src="../../db42-4.2.52/images/ref.gif" alt="Ref"></a>
</td></tr></table>
<p><font size=1><a href="../../db42-devel-4.2.52/sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font>
</body>
</html>