diff options
Diffstat (limited to 'db/docs/api_c/rep_stat.html')
| -rw-r--r-- | db/docs/api_c/rep_stat.html | 108 |
1 files changed, 108 insertions, 0 deletions
diff --git a/db/docs/api_c/rep_stat.html b/db/docs/api_c/rep_stat.html new file mode 100644 index 000000000..cd2a83629 --- /dev/null +++ b/db/docs/api_c/rep_stat.html @@ -0,0 +1,108 @@ +<!--Id: rep_stat.so,v 10.7 2002/07/13 18:09:07 margo Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: DB_ENV->rep_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>DB_ENV->rep_stat</h1> +</td> +<td align=right> +<a href="../api_c/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.h> +<p> +int +DB_ENV->rep_stat(DB_ENV *env, DB_REP_STAT **statp, u_int32_t flags); +</pre></h3> +<h1>Description</h1> +<p>The DB_ENV->rep_stat function returns the replication 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 DB_ENV->rep_stat function creates a statistical structure of type +DB_REP_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_c/env_set_alloc.html">DB_ENV->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_REP_STAT fields will be filled in: +<p><dl compact> +<dt>u_int32_t st_stat;<dd>The current replication mode. Set to <a href="../api_c/rep_start.html#DB_REP_MASTER">DB_REP_MASTER</a> if the +environment is a replication master, <a href="../api_c/rep_start.html#DB_REP_CLIENT">DB_REP_CLIENT</a> if the +environment is a replication client, <a href="../api_c/rep_start.html#DB_REP_LOGSONLY">DB_REP_LOGSONLY</a> if the +environment is a log-files-only replica, or 0 if replication is not +configured. +<dt>DB_LSN st_next_lsn;<dd>In replication environments configured as masters, the next LSN expected. +In replication environments configured as clients, the next LSN to be used. +<dt>DB_LSN st_waiting_lsn;<dd>The LSN of the first missed log record being waited for, or 0 if no log +records are currently missing. +<dt>u_int32_t st_dupmasters;<dd>The number of duplicate master conditions detected. +<dt>u_int32_t st_env_id;<dd>The current environment ID. +<dt>u_int32_t st_env_priority;<dd>The current environment priority. +<dt>u_int32_t st_gen;<dd>The current generation number. +<dt>u_int32_t st_log_duplicated;<dd>The number of duplicate log records received. +<dt>u_int32_t st_log_queued;<dd>The number of log records currently queued. +<dt>u_int32_t st_log_queued_max;<dd>The maximum number of log records ever queued at once. +<dt>u_int32_t st_log_queued_total;<dd>The total number of log records queued. +<dt>u_int32_t st_log_records;<dd>The number of log records received and appended to the log. +<dt>u_int32_t st_log_requested;<dd>The number of log records missed and requested. +<dt>u_int32_t st_master;<dd>The current master environment ID. +<dt>u_int32_t st_master_changes;<dd>The number of times the master has changed. +<dt>u_int32_t st_msgs_badgen;<dd>The number of messages received with a bad generation number. +<dt>u_int32_t st_msgs_processed;<dd>The number of messages received and processed. +<dt>u_int32_t st_msgs_recover;<dd>The number of messages ignored due to pending recovery. +<dt>u_int32_t st_msgs_send_failures;<dd>The number of failed message sends. +<dt>u_int32_t st_msgs_sent;<dd>The number of messages sent. +<dt>u_int32_t st_newsites;<dd>The number of new site messages received. +<dt>u_int32_t st_outdated;<dd>The number of outdated conditions detected. +<dt>u_int32_t st_txns_applied;<dd>The number of transactions applied. +<dt>u_int32_t st_elections;<dd>The number of elections held. +<dt>u_int32_t st_elections_won;<dd>The number of elections won. +<dt>u_int32_t st_election_status;<dd>The current election phase (0 if no election is in progress). +<dt>u_int32_t st_election_cur_winner;<dd>The election winner. +<dt>u_int32_t st_election_gen;<dd>The election generation number. +<dt>DB_LSN st_election_lsn;<dd>The maximum LSN of election winner. +<dt>u_int32_t st_election_nsites;<dd>The number sites expected to participate in elections. +<dt>u_int32_t st_nthrottles;<dd>Transmission limited. This indicates the number of times that data +transmission was stopped to limit the amount of data sent in response +to a single call to <a href="../api_c/rep_message.html">DB_ENV->rep_process_message</a>. +<dt>u_int32_t st_election_priority;<dd>The election priority. +<dt>u_int32_t st_election_tiebreaker;<dd>The election tiebreaker value. +<dt>u_int32_t st_election_votes;<dd>The votes received this election round. +</dl> +<p>The DB_ENV->rep_stat function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The DB_ENV->rep_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 DB_ENV->rep_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/rep_start.html">DB_ENV->rep_start</a>, +<a href="../api_c/rep_elect.html">DB_ENV->rep_elect</a>, +<a href="../api_c/rep_message.html">DB_ENV->rep_process_message</a> +and +<a href="../api_c/rep_transport.html">DB_ENV->set_rep_transport</a>. +</tt> +<table width="100%"><tr><td><br></td><td align=right> +<a href="../api_c/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> |