diff options
Diffstat (limited to 'db/docs/api_c/log_stat.html')
| -rw-r--r-- | db/docs/api_c/log_stat.html | 90 |
1 files changed, 90 insertions, 0 deletions
diff --git a/db/docs/api_c/log_stat.html b/db/docs/api_c/log_stat.html new file mode 100644 index 000000000..819c603d3 --- /dev/null +++ b/db/docs/api_c/log_stat.html @@ -0,0 +1,90 @@ +<!--$Id: log_stat.so,v 10.23 2000/05/25 13:47:08 dda Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: 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><tr valign=top> +<td> +<h1>log_stat</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +log_stat(DB_ENV *env, + DB_LOG_STAT **spp, void *(*db_malloc)(size_t)); +</pre></h3> +<h1>Description</h1> +<p>The log_stat function +creates a statistical structure and copies a pointer to it into a +user-specified memory location. +<p>Statistical structures are created in allocated memory. If <b>db_malloc</b> is non-NULL, it +is called to allocate the memory, otherwise, the library function +<b>malloc</b>(3) is used. The function <b>db_malloc</b> must match +the calling conventions of the <b>malloc</b>(3) library routine. +Regardless, the caller is responsible for deallocating the returned +memory. To deallocate returned memory, free the returned memory +reference, references inside the returned memory do not need to be +individually freed. +<p>The log region statistics are stored in a structure of type DB_LOG_STAT. +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>u_int32_t st_regsize;<dd>The size of the region. +<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_max;<dd>The maximum size of any individual file comprising the log. +<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_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 log_stat function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The log_stat function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the log_stat function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_set_lg_bsize.html">DBENV->set_lg_bsize</a>, +<a href="../api_c/env_set_lg_max.html">DBENV->set_lg_max</a>, +<a href="../api_c/log_archive.html">log_archive</a>, +<a href="../api_c/log_compare.html">log_compare</a>, +<a href="../api_c/log_file.html">log_file</a>, +<a href="../api_c/log_flush.html">log_flush</a>, +<a href="../api_c/log_get.html">log_get</a>, +<a href="../api_c/log_put.html">log_put</a>, +<a href="../api_c/log_register.html">log_register</a>, +<a href="../api_c/log_stat.html">log_stat</a> +and +<a href="../api_c/log_unregister.html">log_unregister</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.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> |