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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
<!--$Id: rep_stat.so,v 10.32 2004/08/13 03:39:02 bostic Exp $-->
<!--Copyright 1997-2004 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DbEnv::rep_stat</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
</head>
<body bgcolor=white>
<table width="100%"><tr valign=top>
<td>
<h3>DbEnv::rep_stat</h3>
</td>
<td align=right>
<a href="../api_cxx/api_core.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_cxx.h>
<p>
int
DbEnv::rep_stat(DB_REP_STAT **statp, u_int32_t flags);
<p>
int
DbEnv::rep_stat_print(u_int32_t flags);
</pre></h3>
<hr size=1 noshade>
<h3>Description: DbEnv::rep_stat</h3>
<p>The DbEnv::rep_stat method returns the replication subsystem statistics.</p>
<p>The DbEnv::rep_stat method creates a statistical structure of type
DB_REP_STAT and copies a pointer to it into a user-specified memory
location.</p>
<p>Statistical structures are stored 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
standard C library <b>malloc</b>(3) 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>
<p>The following DB_REP_STAT fields will be filled in:</p>
<dl compact>
<dt>u_int32_t st_status;<dd>The current replication mode. Set to <a href="../api_cxx/rep_start.html#DB_REP_MASTER">DB_REP_MASTER</a> if the
environment is a replication master, <a href="../api_cxx/rep_start.html#DB_REP_CLIENT">DB_REP_CLIENT</a> if the
environment is a replication client, 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 log record we have after missing log records
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_egen;<dd>The current election 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>int st_nsites;<dd>The number of sites believed to be in the replication group.
<dt>u_int32_t st_outdated;<dd>The number of outdated conditions detected.
<dt>u_int32_t st_next_pg;<dd>The next page number we expect to receive.
<dt>u_int32_t st_waiting_pg;<dd>The page number of the first page we have after missing pages
being waited for, or 0 if no pages are currently missing.
<dt>u_int32_t st_pg_duplicated;<dd>The number of duplicate pages received.
<dt>u_int32_t st_pg_records;<dd>The number of pages received and stored.
<dt>u_int32_t st_pg_requested;<dd>The number of pages missed and requested from the master.
<dt>u_int32_t st_startup_complete;<dd>The client site has completed its startup procedures and is now
handling live records from the master.
<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_election_nvotes;<dd>The number of votes required to complete the election.
<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_cxx/rep_message.html">DbEnv::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 DbEnv::rep_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.
</p>
<h3>Parameters</h3>
<dl compact>
<dt><b>flags</b><dd>The <b>flags</b> parameter must be set to 0 or
the following value:
<dl compact>
<dt><a name="DB_STAT_CLEAR">DB_STAT_CLEAR</a><dd>Reset statistics after returning their values.
</dl>
<dt><b>statp</b><dd>The <b>statp</b> parameter references memory into which
a pointer to the allocated statistics structure is copied.
</dl>
<h3>Errors</h3>
<p>The DbEnv::rep_stat method
may fail and throw
<a href="../api_cxx/except_class.html">DbException</a>,
encapsulating one of the following non-zero errors, or return one of
the following non-zero errors:</p>
<dl compact>
<dt>EINVAL<dd>An
invalid flag value or parameter was specified.
</dl>
<hr size=1 noshade>
<h3>Description: DbEnv::rep_stat_print</h3>
<p>The DbEnv::rep_stat_print method returns the
replication subsystem statistical information, as described for the DbEnv::rep_stat method.
The information is printed to a specified output channel (see the
<a href="../api_cxx/env_set_msgfile.html">DbEnv::set_msgfile</a> method for more information), or passed to an
application callback function (see the <a href="../api_cxx/env_set_msgcall.html">DbEnv::set_msgcall</a> method for
more information).</p>
<p>The DbEnv::rep_stat_print method may not be called before the <a href="../api_cxx/env_open.html">DbEnv::open</a> method has
been called.</p>
<p>The DbEnv::rep_stat_print 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.
</p>
<h3>Parameters</h3>
<dl compact>
<dt><b>flags</b><dd>The <b>flags</b> parameter must be set to 0 or
the following value:
<dl compact>
<dt><a name="DB_STAT_ALL">DB_STAT_ALL</a><dd>Display all available information.
</dl>
</dl>
<hr size=1 noshade>
<h3>Class</h3>
<a href="../api_cxx/env_class.html">DbEnv</a>
<h3>See Also</h3>
<a href="../api_cxx/rep_list.html">Replication and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_cxx/api_core.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="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font>
</body>
</html>
|
