1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
|
<!--$Id: log_stat.html,v 1.1.1.1 2003/11/20 22:14:30 toshok Exp $-->
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DbEnv::log_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>
<h1>DbEnv::log_stat</h1>
</td>
<td align=right>
<a href="../api_cxx/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<hr size=1 noshade>
<tt>
<h3><pre>
#include <db_cxx.h>
<p>
int
DbEnv::log_stat(DB_LOG_STAT **spp, u_int32_t flags);
</pre></h3>
<h1>Description</h1>
<p>The DbEnv::log_stat method returns the logging subsystem statistics.
<p>The <b>flags</b> value 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>The DbEnv::log_stat method creates a statistical structure of type
DB_LOG_STAT and copies a pointer to it into a user-specified memory
location.
<p>Statistical structures are created in allocated memory. If application-specific allocation
routines have been declared (see <a href="../api_cxx/env_set_alloc.html">DbEnv::set_alloc</a> for more
information), they are used to allocate the memory; otherwise, the
library <b>malloc</b>(3) interface 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>The following DB_LOG_STAT fields will be filled in:
<p><dl compact>
<dt>u_int32_t st_magic;<dd>The magic number that identifies a file as a log file.
<dt>u_int32_t st_version;<dd>The version of the log file type.
<dt>int st_mode;<dd>The mode of any created log files.
<dt>u_int32_t st_lg_bsize;<dd>The in-memory log record cache size.
<dt>u_int32_t st_lg_size;<dd>The current log file size.
<dt>u_int32_t st_w_mbytes;<dd>The number of megabytes written to this log.
<dt>u_int32_t st_w_bytes;<dd>The number of bytes over and above <b>st_w_mbytes</b> written to this log.
<dt>u_int32_t st_wc_mbytes;<dd>The number of megabytes written to this log since the last checkpoint.
<dt>u_int32_t st_wc_bytes;<dd>The number of bytes over and above <b>st_wc_mbytes</b> written to this log
since the last checkpoint.
<dt>u_int32_t st_wcount;<dd>The number of times the log has been written to disk.
<dt>u_int32_t st_wcount_fill;<dd>The number of times the log has been written to disk because the
in-memory log record cache filled up.
<dt>u_int32_t st_scount;<dd>The number of times the log has been flushed to disk.
<dt>u_int32_t st_cur_file;<dd>The current log file number.
<dt>u_int32_t st_cur_offset;<dd>The byte offset in the current log file.
<dt>u_int32_t st_disk_file;<dd>The log file number of the last record known to be on disk.
<dt>u_int32_t st_disk_offset;<dd>The byte offset of the last record known to be on disk.
<dt>u_int32_t st_cur_offset;<dd>The byte offset of the last record known to be on disk.
<dt>u_int32_t st_maxcommitperflush;<dd>The maximum number of commits contained in a single log flush.
<dt>u_int32_t st_mincommitperflush;<dd>The minimum number of commits contained in a single log flush that
contained a commit.]
<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.
</dl>
<p>The DbEnv::log_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.
<h1>Errors</h1>
<p>The DbEnv::log_stat method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods.
If a catastrophic error has occurred, the DbEnv::log_stat method may fail and
either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a
<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>,
in which case all subsequent Berkeley DB calls will fail in the same way.
<h1>Class</h1>
<a href="../api_cxx/env_class.html">DbEnv</a>, <a href="../api_cxx/logc_class.html">DbLogc</a>, <a href="../api_cxx/lsn_class.html">DbLsn</a>
<h1>See Also</h1>
<a href="../api_cxx/log_list.html">Logging Subsystem and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_cxx/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
</body>
</html>
|