libdb/docs/api_reference/CXX/mutexstat_print.html
2011-09-13 13:44:24 -04:00

156 lines
5.9 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::mutex_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="mutex.html" title="Chapter 10.  Mutex Methods" />
<link rel="prev" href="mutexstat.html" title="DbEnv::mutex_stat()" />
<link rel="next" href="mutexunlock.html" title="DbEnv::mutex_unlock()" />
</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::mutex_stat_print()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="mutexstat.html">Prev</a> </td>
<th width="60%" align="center">Chapter 10. 
Mutex Methods
</th>
<td width="20%" align="right"> <a accesskey="n" href="mutexunlock.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="mutexstat_print"></a>DbEnv::mutex_stat_print()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include &lt;db_cxx.h&gt;
int
DbEnv::mutex_stat_print(u_int32_t flags);</pre>
<p>
The <code class="methodname">DbEnv::mutex_stat_print()</code> method displays the mutex subsystem
statistical information, as described for the <code class="methodname">DbEnv::mutex_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::mutex_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::mutex_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="id3654483"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id3654088"></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>
<code class="literal">DB_STAT_ALL</code>
</p>
<p>
Display all available information.
</p>
</li>
<li>
<p>
<code class="literal">DB_STAT_CLEAR</code>
</p>
<p>
Reset statistics after displaying their values.
</p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id3654779"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="env.html" title="Chapter 5.  The DbEnv Handle">DbEnv</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id3653894"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="mutex.html#mutexlist" title="Mutex Methods">Mutex 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="mutexstat.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="mutex.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="mutexunlock.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DbEnv::mutex_stat() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DbEnv::mutex_unlock()</td>
</tr>
</table>
</div>
</body>
</html>