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
|
<?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::repmgr_site_list()</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="repmgr_site_by_eid.html" title="DbEnv::repmgr_site_by_eid()" />
<link rel="next" href="repmgrstart.html" title="DbEnv::repmgr_start()" />
</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::repmgr_site_list()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="repmgr_site_by_eid.html">Prev</a> </td>
<th width="60%" align="center">Chapter 11.
Replication Methods
</th>
<td width="20%" align="right"> <a accesskey="n" href="repmgrstart.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="repmgrsite_list"></a>DbEnv::repmgr_site_list()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db_cxx.h>
int
DbEnv::repmgr_site_list(u_int *countp, DB_REPMGR_SITE **listp);</pre>
<p>
The <code class="methodname">DbEnv::repmgr_site_list()</code> method returns the status of the
sites currently known by the Replication Manager.
</p>
<p>
The <code class="methodname">DbEnv::repmgr_site_list()</code> method creates a statistical
structure of type <code class="literal">DB_REPMGR_SITE</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_REPMGR_SITE</code> fields will be filled in:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p>
<span class="bold"><strong>int eid;</strong></span>
</p>
<p>
Environment ID assigned by the Replication Manager. This is the same value that is passed to
the application's event notification function for the
<a class="link" href="envevent_notify.html#event_notify_DB_EVENT_REP_NEWMASTER">DB_EVENT_REP_NEWMASTER</a>
event.
</p>
</li>
<li>
<p>
<span class="bold"><strong>char host[];</strong></span>
</p>
<p>
Null-terminated host name.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int port;</strong></span>
</p>
<p>
TCP/IP port number.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t status;</strong></span>
</p>
<p>
Zero (if unknown), or one of the following
constants: <code class="literal">DB_REPMGR_CONNECTED</code>,
<code class="literal">DB_REPMGR_DISCONNECTED</code>.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t flags;</strong></span>
</p>
<p>
Zero or a bitwise inclusive OR of the <code class="literal">DB_REPMGR_ISPEER</code> constant.
The <code class="literal">DB_REPMGR_ISPEER</code>
value means that the site is a possible client-to-client peer.
</p>
</li>
</ul>
</div>
<p>
The <code class="methodname">DbEnv::repmgr_site_list()</code> method may be called only after the
<a class="xref" href="repmgrstart.html" title="DbEnv::repmgr_start()">DbEnv::repmgr_start()</a> method
has been called with a <code class="literal">0</code> return code.
</p>
<p>
The <code class="methodname">DbEnv::repmgr_site_list()</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="idp9941720"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp9943816"></a>countp</h4>
</div>
</div>
</div>
<p>
A count of the returned structures will be stored into the memory referenced by
<span class="bold"><strong>countp</strong></span>.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp9949288"></a>listp</h4>
</div>
</div>
</div>
<p>
A reference to an array of structures will be stored into the memory referenced by
<span class="bold"><strong>listp</strong></span>.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp9946320"></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="idp9936072"></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="repmgr_site_by_eid.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="repmgrstart.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DbEnv::repmgr_site_by_eid() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DbEnv::repmgr_start()</td>
</tr>
</table>
</div>
</body>
</html>
|
