libdb/docs/api_reference/CXX/lockstat_print.html
2011-12-19 19:07:10 -05:00

191 lines
7.2 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>DbEnv::lock_stat_print()</title>
<link rel="stylesheet" href="apiReference.css" type="text/css" />
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
<link rel="start" href="index.html" title="Berkeley DB C++ API Reference" />
<link rel="up" href="lock.html" title="Chapter 7.  The DbLock Handle" />
<link rel="prev" href="lockstat.html" title="DbEnv::lock_stat()" />
<link rel="next" href="lockvec.html" title="DbEnv::lock_vec()" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 11.2.5.2</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">DbEnv::lock_stat_print()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="lockstat.html">Prev</a> </td>
<th width="60%" align="center">Chapter 7. 
The DbLock Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="lockvec.html">Next</a></td>
</tr>
</table>
<hr />
</div>
<div class="sect1" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a id="lockstat_print"></a>DbEnv::lock_stat_print()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include &lt;db_cxx.h&gt;
int
DbEnv::lock_stat_print(u_int32_t flags);</pre>
<p>
The <code class="methodname">DbEnv::lock_stat_print()</code> method displays the locking subsystem
statistical information, as described for the <code class="methodname">DbEnv::lock_stat()</code>
method. The information is printed to a specified output channel (see
the <a class="xref" href="envset_msgfile.html" title="DbEnv::set_msgfile()">DbEnv::set_msgfile()</a>
method for more information), or passed to an application callback
function (see the
<a class="xref" href="envset_msgcall.html" title="DbEnv::set_msgcall()">DbEnv::set_msgcall()</a>
method for more information).
</p>
<p>
The <code class="methodname">DbEnv::lock_stat_print()</code> method may not be called before the
<a class="xref" href="envopen.html" title="DbEnv::open()">DbEnv::open()</a> method is
called.
</p>
<p>
The <code class="methodname">DbEnv::lock_stat_print()</code> <span>
<span>
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.
</span>
</span>
</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id3616051"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id3615622"></a>flags</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>flags</strong></span> parameter must be set to 0
or by bitwise inclusively <span class="bold"><strong>OR</strong></span>'ing
together one or more of the following values:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p><a id="lockstat_print_DB_STAT_ALL"></a>
<code class="literal">DB_STAT_ALL</code>
</p>
<p>
Display all available information.
</p>
</li>
<li>
<p><a id="envsat_print_DB_STAT_CLEAR"></a>
<code class="literal">DB_STAT_CLEAR</code>
</p>
<p>
Reset statistics after displaying their values.
</p>
</li>
<li>
<p><a id="envsat_print_DB_STAT_LOCK_CONF"></a>
<code class="literal">DB_STAT_LOCK_CONF</code>
</p>
<p>
Display the lock conflict matrix.
</p>
</li>
<li>
<p><a id="envsat_print_DB_STAT_LOCK_LOCKERS"></a>
<code class="literal">DB_STAT_LOCK_LOCKERS</code>
</p>
<p>
Display the lockers within hash chains.
</p>
</li>
<li>
<p><a id="envsat_print_DB_STAT_LOCK_OBJECTS"></a>
<code class="literal">DB_STAT_LOCK_OBJECTS</code>
</p>
<p>
Display the lock objects within hash chains.
</p>
</li>
<li>
<p><a id="envsat_print_DB_STAT_LOCK_PARAMS"></a>
<code class="literal">DB_STAT_LOCK_PARAMS</code>
</p>
<p>
Display the locking subsystem parameters.
</p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id3616609"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="env.html" title="Chapter 5.  The DbEnv Handle">DbEnv</a>,
<a class="link" href="lock.html" title="Chapter 7.  The DbLock Handle">DbLock</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id3616440"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="lock.html#locklist" title="Locking Subsystem and Related Methods">Locking Subsystem and Related Methods</a>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="lockstat.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="lock.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="lockvec.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DbEnv::lock_stat() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DbEnv::lock_vec()</td>
</tr>
</table>
</div>
</body>
</html>