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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
|
<?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::rep_stat()</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="rep.html" title="Chapter 11. Replication Methods" />
<link rel="prev" href="repstart.html" title="DbEnv::rep_start()" />
<link rel="next" href="repstat_print.html" title="DbEnv::rep_stat_print()" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 11.2.5.3</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">DbEnv::rep_stat()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="repstart.html">Prev</a> </td>
<th width="60%" align="center">Chapter 11.
Replication Methods
</th>
<td width="20%" align="right"> <a accesskey="n" href="repstat_print.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="repstat"></a>DbEnv::rep_stat()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db_cxx.h>
int
DbEnv::rep_stat(DB_REP_STAT **statp, u_int32_t flags); </pre>
<p>
The <code class="methodname">DbEnv::rep_stat()</code> method returns the replication subsystem
statistics.
</p>
<p>
The <code class="methodname">DbEnv::rep_stat()</code> method creates a statistical structure of type
<code class="literal">DB_REP_STAT</code> 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 class="xref" href="envset_alloc.html" title="DbEnv::set_alloc()">DbEnv::set_alloc()</a>
for more information), they are used to allocate the memory; otherwise, the standard
C library <span class="bold"><strong>malloc</strong></span>(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 <code class="literal">DB_REP_STAT</code> fields will be filled in:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p>
<span class="bold"><strong>uintmax_t st_bulk_fills;</strong></span>
</p>
<p>
The number of times the bulk buffer filled up, forcing the buffer
content to be sent.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_bulk_overflows;</strong></span>
</p>
<p>
The number of times a record was bigger than the entire bulk buffer,
and therefore had to be sent as a singleton.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_bulk_records;</strong></span>
</p>
<p>
The number of records added to a bulk buffer.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_bulk_transfers;</strong></span>
</p>
<p>
The number of bulk buffers transferred (via a call to the
application's <span class="bold"><strong>send</strong></span> function).
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_client_rerequests;</strong></span>
</p>
<p>
The number of times this client site received a "re-request" message,
indicating that a request it previously sent to another client could
not be serviced by that client. (Compare to <span class="bold"><strong>st_client_svc_miss</strong></span>.)
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_client_svc_miss;</strong></span>
</p>
<p>
The number of "request" type messages received by this client that
could not be processed, forcing the originating requester to try
sending the request to the master (or another client).
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_client_svc_req;</strong></span>
</p>
<p>
The number of "request" type messages received by this client.
("Request" messages are usually sent from a client to the master, but
a message marked with the
<a class="link" href="reptransport.html#transport_DB_REP_ANYWHERE">DB_REP_ANYWHERE</a>
flag in the invocation of the application's <span class="bold"><strong>send</strong></span> function may be sent to another client
instead.)
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_dupmasters;</strong></span>
</p>
<p>
The number of duplicate master conditions originally detected at this
site.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_egen;</strong></span>
</p>
<p>
The election generation number for the current or next election.
</p>
</li>
<li>
<p>
<span class="bold"><strong>int st_election_cur_winner;</strong></span>
</p>
<p>
The environment ID of the winner of the current or last election.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_election_datagen;</strong></span>
</p>
<p>
The master data generation number of the winner of the
current or last election.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_election_gen;</strong></span>
</p>
<p>
The master generation number of the winner of the current or last election.
</p>
</li>
<li>
<p>
<span class="bold"><strong>DB_LSN st_election_lsn;</strong></span>
</p>
<p>
The maximum LSN of the winner of the current or last election.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_election_nsites;</strong></span>
</p>
<p>
The number of sites responding to this site during the current election.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_election_nvotes;</strong></span>
</p>
<p>
The number of votes required in the current or last election.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_election_priority;</strong></span>
</p>
<p>
The priority of the winner of the current or last election.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_election_sec;</strong></span>
</p>
<p>
The number of seconds the last election took (the total election time
is <span class="bold"><strong>st_election_sec</strong></span> plus <span class="bold"><strong>st_election_usec</strong></span>).
</p>
</li>
<li>
<p>
<span class="bold"><strong>int st_election_status;</strong></span>
</p>
<p>
The current election phase (0 if no election is in progress).
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_election_tiebreaker;</strong></span>
</p>
<p>
The tiebreaker value of the winner of the current or last election.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_election_usec;</strong></span>
</p>
<p>
The number of microseconds the last election took (the total election
time is <span class="bold"><strong>st_election_sec</strong></span> plus
<span class="bold"><strong>st_election_usec</strong></span>).
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_election_votes;</strong></span>
</p>
<p>
The number of votes received during the current election.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_elections;</strong></span>
</p>
<p>
The number of elections held.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_elections_won;</strong></span>
</p>
<p>
The number of elections won.
</p>
</li>
<li>
<p>
<span class="bold"><strong>int st_env_id;</strong></span>
</p>
<p>
The current environment ID.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_env_priority;</strong></span>
</p>
<p>
The current environment priority.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_gen;</strong></span>
</p>
<p>
The current master generation number.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_lease_chk;</strong></span>
</p>
<p>
The number of lease validity checks.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_lease_chk_misses;</strong></span>
</p>
<p>
The number of invalid lease validity checks.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_lease_chk_refresh;</strong></span>
</p>
<p>
The number of lease refresh attempts during lease
validity checks.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_lease_sends;</strong></span>
</p>
<p>
The number of live messages sent while using leases.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_log_duplicated;</strong></span>
</p>
<p>
The number of duplicate log records received.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_log_queued;</strong></span>
</p>
<p>
The number of log records currently queued.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_log_queued_max;</strong></span>
</p>
<p>
The maximum number of log records ever queued at once.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_log_queued_total;</strong></span>
</p>
<p>
The total number of log records queued.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_log_records;</strong></span>
</p>
<p>
The number of log records received and appended to the log.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_log_requested;</strong></span>
</p>
<p>
The number of times log records were missed and requested.
</p>
</li>
<li>
<p>
<span class="bold"><strong>int st_master;</strong></span>
</p>
<p>
The current master environment ID.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_master_changes;</strong></span>
</p>
<p>
The number of times the master has changed.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_max_lease_sec;</strong></span>
</p>
<p>
The number of seconds of the longest lease (the total lease time is
<span class="bold"><strong>st_max_lease_sec</strong></span> plus <span class="bold"><strong>st_max_lease_usec</strong></span>).
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_max_lease_usec;</strong></span>
</p>
<p>
The number of microseconds of the longest lease (the total lease time
is <span class="bold"><strong>st_max_lease_sec</strong></span> plus <span class="bold"><strong>st_max_lease_usec</strong></span>).
</p>
</li>
<li>
<p>
<span class="bold"><strong>DB_LSN st_max_perm_lsn;</strong></span>
</p>
<p>
The LSN of the maximum permanent log record, or 0 if there are no
permanent log records.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_msgs_badgen;</strong></span>
</p>
<p>
The number of messages received with a bad generation number.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_msgs_processed;</strong></span>
</p>
<p>
The number of messages received and processed.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_msgs_recover;</strong></span>
</p>
<p>
The number of messages ignored due to pending recovery.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_msgs_send_failures;</strong></span>
</p>
<p>
The number of failed message sends.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_msgs_sent;</strong></span>
</p>
<p>
The number of messages sent.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_newsites;</strong></span>
</p>
<p>
The number of new site messages received.
</p>
</li>
<li>
<p>
<span class="bold"><strong>DB_LSN st_next_lsn;</strong></span>
</p>
<p>
In replication environments configured as masters, the next LSN
to be used. In replication environments configured as clients, the next
LSN expected.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_next_pg;</strong></span>
</p>
<p>
The next page number we expect to receive.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_nsites;</strong></span>
</p>
<p>
The number of sites used in the last election.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_nthrottles;</strong></span>
</p>
<p>
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 class="xref" href="repmessage.html" title="DbEnv::rep_process_message()">DbEnv::rep_process_message()</a>.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_outdated;</strong></span>
</p>
<p>
The number of outdated conditions detected.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_pg_duplicated;</strong></span>
</p>
<p>
The number of duplicate pages received.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_pg_records;</strong></span>
</p>
<p>
The number of pages received and stored.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_pg_requested;</strong></span>
</p>
<p>
The number of pages missed and requested from the master.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_startsync_delayed;</strong></span>
</p>
<p>
The number of times the client had to delay the start of a cache flush
operation (initiated by the master for an impending checkpoint)
because it was missing some previous log record(s).
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_startup_complete;</strong></span>
</p>
<p>
The client site has completed its startup procedures and is now
handling live records from the master.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_status;</strong></span>
</p>
<p>
The current replication mode. Set to
<a class="link" href="repmgrstart.html#repmgrstart_DB_REP_MASTER">DB_REP_MASTER</a>
if the environment is a replication master,
<a class="link" href="repmgrstart.html#repmgrstart_DB_REP_CLIENT">DB_REP_CLIENT</a>
if the environment is a replication client, or 0 if replication is not
configured.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_txns_applied;</strong></span>
</p>
<p>
The number of transactions applied.
</p>
</li>
<li>
<p>
<span class="bold"><strong>DB_LSN st_waiting_lsn;</strong></span>
</p>
<p>
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.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_waiting_pg;</strong></span>
</p>
<p>
The page number of the first page we have after missing pages being
waited for, or 0 if no pages are currently missing.
</p>
</li>
</ul>
</div>
<p>
The <code class="methodname">DbEnv::rep_stat()</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::rep_stat()</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="idp9801736"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp9770864"></a>statp</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>statp</strong></span> parameter references memory
into which a pointer to the allocated statistics structure is copied.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp9805048"></a>flags</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>flags</strong></span> parameter must be set to 0
or the following value:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p>
<code class="literal">DB_STAT_CLEAR</code>
</p>
<p>
Reset statistics after returning 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="idp9810800"></a>Errors</h3>
</div>
</div>
</div>
<p>
The <code class="methodname">DbEnv::rep_stat()</code> <span>
<span>
method may fail and throw a <a class="link" href="dbexception.html" title="Chapter 6. The DbException Class">DbException</a>
exception, encapsulating one of the following non-zero errors, or return one
of the following non-zero errors:
</span>
</span>
</p>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp9818328"></a>EINVAL</h4>
</div>
</div>
</div>
<p>
If the database environment was not already opened; or if an invalid
flag value or parameter was specified.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp9817248"></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="idp9813880"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="rep.html#replist" title="Replication and Related Methods">Replication and Related 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="repstart.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="rep.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="repstat_print.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DbEnv::rep_start() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DbEnv::rep_stat_print()</td>
</tr>
</table>
</div>
</body>
</html>
|
