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
|
<?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_start()</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="repmgrsite_list.html" title="DbEnv::repmgr_site_list()" />
<link rel="next" href="repmgrstat.html" title="DbEnv::repmgr_stat()" />
</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_start()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="repmgrsite_list.html">Prev</a> </td>
<th width="60%" align="center">Chapter 11.
Replication Methods
</th>
<td width="20%" align="right"> <a accesskey="n" href="repmgrstat.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="repmgrstart"></a>DbEnv::repmgr_start()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db_cxx.h>
int
DbEnv::repmgr_start(int nthreads, u_int32_t flags);</pre>
<p>
The <code class="methodname">DbEnv::repmgr_start()</code> method starts the Replication Manager.
</p>
<p>
There are two ways to build Berkeley DB replication applications: the
most common approach is to use the Berkeley DB library Replication
Manager, where the Berkeley DB library manages the
replication group, including network transport, all replication
message processing and acknowledgment, and group elections.
Applications using the Replication Manager generally make the
following calls:
</p>
<div class="orderedlist">
<ol type="1">
<li>
<p>
Use <a class="xref" href="repmgr_site.html" title="DbEnv::repmgr_site()">DbEnv::repmgr_site()</a>
to obtain a DbSite handle, then use that handle to
configure the sites in your replication group.
</p>
<div class="orderedlist">
<ol type="a">
<li>
<p>
Use <a class="xref" href="dbsite_set_config.html" title="DbSite::set_config()">DbSite::set_config()</a>
to configure sites in your replication group.
</p>
</li>
<li>
<p>
Use <a class="xref" href="dbsite_remove.html" title="DbSite::remove()">DbSite::remove()</a>
to remove a site from the replication group.
</p>
</li>
</ol>
</div>
</li>
<li>
<p>
Call
<a class="xref" href="repmgrset_ack_policy.html" title="DbEnv::repmgr_set_ack_policy()">DbEnv::repmgr_set_ack_policy()</a>
to configure the message acknowledgment policy which best supports the
replication group's transactional needs.
</p>
</li>
<li>
<p>
Call
<a class="xref" href="reppriority.html" title="DbEnv::rep_set_priority()">DbEnv::rep_set_priority()</a>
to configure the local site's election priority.
</p>
</li>
<li>
<p>
Call <code class="methodname">DbEnv::repmgr_start()</code> to start the replication application.
</p>
</li>
</ol>
</div>
<p>
For more information on building Replication Manager applications,
please see the <em class="citetitle">Replication Getting Started Guide</em>
included in the Berkeley DB documentation.
</p>
<p>
Applications with special needs (for example, applications using
network protocols not supported by the Berkeley DB Replication
Manager), must perform additional configuration and call other
Berkeley DB replication Base API methods. For more information on building
Base API applications, please see the
<a href="../../programmer_reference/rep_base_meth.html" class="olink">Base API Methods</a> section in the
<em class="citetitle">Berkeley DB Programmer's Reference Guide</em>.
</p>
<p>
Starting the Replication Manager consists of opening the TCP/IP listening socket to accept
incoming connections, and starting all necessary background threads. When multiple processes
share a database environment, only one process can open the listening socket; the
<code class="methodname">DbEnv::repmgr_start()</code> method automatically opens the socket in the
first process to call it, and skips this step in the later calls from other processes.
</p>
<p>
The <code class="methodname">DbEnv::repmgr_start()</code> method
may not be called before the <a class="xref" href="envopen.html" title="DbEnv::open()">DbEnv::open()</a> method is
called to open. In addition, this method may not be called before
your replication sites have been configured using the
<a class="link" href="db_site.html" title="The DbSite Handle">DbSite</a> class.
In addition, the local environment must be opened with the
<a class="link" href="envopen.html#envopen_DB_THREAD">DB_THREAD</a>
flag set.
</p>
<p>
The <code class="methodname">DbEnv::repmgr_start()</code> method will return
<code class="literal">DB_REP_IGNORE</code>
as an informational, non-error return code, if another process has previously become the
TCP/IP listener (though the current call has nevertheless successfully started Replication
Manager's background threads). Unless otherwise specified, the
<code class="methodname">DbEnv::repmgr_start()</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="idp9960648"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp9967928"></a>nthreads</h4>
</div>
</div>
</div>
<p>
Specify the number of threads of control created and dedicated to
processing replication messages. In addition to these message
processing threads, the Replication Manager creates and manages a few
of its own threads of control. The TCP/IP listener
process can change this value after the Replication
Manager is started with a subsequent call to the
<code class="methodname">DbEnv::repmgr_start()</code> method.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp9960328"></a>flags</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>flags</strong></span> parameter must be set to
one of the following values when first starting the
Replication Manager:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p><a id="repmgrstart_DB_REP_MASTER"></a>
<code class="literal">DB_REP_MASTER</code>
</p>
<p>
Start as a master site, and do not call for an election. Note there
must never be more than a single master in any replication group, and
only one site at a time should ever be started with the DB_REP_MASTER
flag specified.
</p>
</li>
<li>
<p><a id="repmgrstart_DB_REP_CLIENT"></a>
<code class="literal">DB_REP_CLIENT</code>
</p>
<p>
Start as a client site, and do not call for an election.
</p>
</li>
<li>
<p>
<code class="literal">DB_REP_ELECTION</code>
</p>
<p>
Start as a client, and call for an election if no master is found.
</p>
</li>
</ul>
</div>
<p>
If the Replication Manager is already started, a
<span class="bold"><strong>flags</strong></span> value of 0 can
be used when making a subsequent call to change the
value of <span class="bold"><strong>nthreads</strong></span>.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp9964456"></a>Errors</h3>
</div>
</div>
</div>
<p>
The <code class="methodname">DbEnv::repmgr_start()</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="idp9970848"></a>DB_REP_UNAVAIL</h4>
</div>
</div>
</div>
<p>
The local site tried to join the group, but was unable to do
so for some reason (because a master site is not available,
or because insufficient replicas are running to acknowledge
the new site). When that happens the application should
pause and retry adding the site until it completes
successfully.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp9982928"></a>EINVAL</h4>
</div>
</div>
</div>
<p>
If the database environment was not already opened or was
opened without the <code class="literal">DB_THREAD</code> flag set; a local
site has not already been configured, this method is called
from a Base API application; 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="idp9975408"></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="idp9978144"></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="repmgrsite_list.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="repmgrstat.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DbEnv::repmgr_site_list() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DbEnv::repmgr_stat()</td>
</tr>
</table>
</div>
</body>
</html>
|
