Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-testing > by-pkgid > d449e127f3976bb1f2f32b825c602e50 > files > 260

lib64db4.6-devel-4.6.21-7mdv2008.1.x86_64.rpm

<!--$Id: txn_stat.so,v 10.67 2007/06/22 16:57:17 bostic Exp $-->
<!--Copyright (c) 1997,2007 Oracle.  All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DB_ENV-&gt;txn_stat</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
</head>
<body bgcolor=white>
<table width="100%"><tr valign=top>
<td>
<h3>DB_ENV-&gt;txn_stat</h3>
</td>
<td align=right>
<a href="../../db46-devel-4.6.21/api_c/api_core.html"><img src="../../db46-devel-4.6.21/images/api.gif" alt="API"></a>
<a href="../../db46-devel-4.6.21/ref/toc.html"><img src="../../db46-devel-4.6.21/images/ref.gif" alt="Ref"></a></td>
</tr></table>
<hr size=1 noshade>
<tt>
<h3><pre>
#include &lt;db.h&gt;
<p>
int
DB_ENV-&gt;txn_stat(DB_ENV *env, DB_TXN_STAT **statp, u_int32_t flags);
<p>
int
DB_ENV-&gt;txn_stat_print(DB_ENV *env, u_int32_t flags);
</pre></h3>
<hr size=1 noshade>
<h3>Description: DB_ENV-&gt;txn_stat</h3>
<p>The DB_ENV-&gt;txn_stat method returns the transaction subsystem statistics.</p>
<p>The DB_ENV-&gt;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="../../db46-devel-4.6.21/api_c/env_set_alloc.html">DB_ENV-&gt;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>
<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_nsnapshot;<dd>The number of transactions on the snapshot list.  These are transactions
which modified a database opened with <a href="../../db46-devel-4.6.21/api_c/db_open.html#DB_MULTIVERSION">DB_MULTIVERSION</a>,
and which have committed or aborted, but the copies of pages they
created are still in the cache.
<dt>u_int32_t st_maxnactive;<dd>The maximum number of active transactions at any one time.
<dt>u_int32_t st_maxnsnapshot;<dd>The maximum number of transactions on the snapshot list 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>roff_t st_regsize;<dd>The size of the transaction region, in bytes.
<dt>u_int32_t st_region_wait;<dd>The number of times that a thread of control was forced to wait before
obtaining the transaction region mutex.
<dt>u_int32_t st_region_nowait;<dd>The number of times that a thread of control was able to obtain
the transaction region mutex 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:
<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>pid_t pid;<dd>The process ID of the originator of the transaction.
<dt>uintmax_t tid;<dd>The thread of control ID of the originator of the transaction.
<dt>DbLsn lsn;<dd>The current log sequence number when the transaction was begun.
<dt>DbLsn read_lsn;<dd>The log sequence number of reads for snapshot transactions.
<dt>u_int32_t mvcc_ref;<dd>The number of buffer copies created by this transaction that remain in cache.
<dt>u_int32_t status;<dd>One of the following list of constants: TXN_ABORTED, TXN_COMMITTED,
TXN_PREPARED, TXN_RUNNING.
<dt>u_int32_t xa_status;<dd>If the transaction is an XA transaction, the <b>xa_status</b> of the
transaction will be one of the following list of constants:
TXN_XA_ABORTED, TXN_XA_DEADLOCKED, TXN_XA_ENDED, TXN_XA_PREPARED,
TXN_XA_STARTED, or TXN_XA_SUSPENDED.  Otherwise, the <b>xa_status</b>
will be 0.
<dt>u_int8_t xid[DB_XIDDATASIZE];<dd>If the transaction is an XA transaction, the transaction's XA ID.  If
the transaction was prepared separately from the XA interfaces, the
transaction's Global ID.  Otherwise, the <b>xid</b> contents are
undefined.
<dt>char name[];<dd>If a name was specified for the transaction, up to the first 50 bytes
of that name, followed by a nul termination byte.
</dl>
</dl>
<p>The DB_ENV-&gt;txn_stat method may not be called before the <a href="../../db46-devel-4.6.21/api_c/env_open.html">DB_ENV-&gt;open</a> method has
been called.</p>
<p>The DB_ENV-&gt;txn_stat method
returns a non-zero error value on failure
and 0 on success.
</p>
<h3>Parameters</h3>
<dl compact>
<dt><b>flags</b><dd>The <b>flags</b> parameter must be set to 0 or
the following value:
<dl compact>
<dt><a name="DB_STAT_CLEAR">DB_STAT_CLEAR</a><dd>Reset statistics after returning their values.
</dl>
<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 DB_ENV-&gt;txn_stat method
may fail and return one of the following non-zero errors:</p>
<dl compact>
<dt>EINVAL<dd>An
invalid flag value or parameter was specified.
</dl>
<hr size=1 noshade>
<h3>Description: DB_ENV-&gt;txn_stat_print</h3>
<p>The DB_ENV-&gt;txn_stat_print method displays the
transaction subsystem statistical information, as described for the DB_ENV-&gt;txn_stat method.
The information is printed to a specified output channel (see the
<a href="../../db46-devel-4.6.21/api_c/env_set_msgfile.html">DB_ENV-&gt;set_msgfile</a> method for more information), or passed to an
application callback function (see the <a href="../../db46-devel-4.6.21/api_c/env_set_msgcall.html">DB_ENV-&gt;set_msgcall</a> method for
more information).</p>
<p>The DB_ENV-&gt;txn_stat_print method may not be called before the <a href="../../db46-devel-4.6.21/api_c/env_open.html">DB_ENV-&gt;open</a> method has
been called.</p>
<p>The DB_ENV-&gt;txn_stat_print method
returns a non-zero error value on failure
and 0 on success.
</p>
<h3>Parameters</h3>
<dl compact>
<dt><b>flags</b><dd>The <b>flags</b> parameter must be set to 0 or by bitwise inclusively <b>OR</b>'ing together one
or more of the following values:
<dl compact>
<dt><a name="DB_STAT_ALL">DB_STAT_ALL</a><dd>Display all available information.
<dt><a name="DB_STAT_CLEAR">DB_STAT_CLEAR</a><dd>Reset statistics after displaying their values.
</dl>
</dl>
<hr size=1 noshade>
<h3>Class</h3>
<a href="../../db46-devel-4.6.21/api_c/env_class.html">DB_ENV</a>, <a href="../../db46-devel-4.6.21/api_c/txn_class.html">DB_TXN</a>
<h3>See Also</h3>
<a href="../../db46-devel-4.6.21/api_c/txn_list.html">Transaction Subsystem and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../../db46-devel-4.6.21/api_c/api_core.html"><img src="../../db46-devel-4.6.21/images/api.gif" alt="API"></a><a href="../../db46-devel-4.6.21/ref/toc.html"><img src="../../db46-devel-4.6.21/images/ref.gif" alt="Ref"></a>
</td></tr></table>
<p><font size=1>Copyright (c) 1996,2007 Oracle.  All rights reserved.</font>
</body>
</html>