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
|
<?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>DB_ENV->repmgr_add_remote_site()</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 10. Replication Methods" />
<link rel="prev" href="repsync.html" title="DB_ENV->rep_sync()" />
<link rel="next" href="repmgrget_ack_policy.html" title="DB_ENV->repmgr_get_ack_policy()" />
</head>
<body>
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">DB_ENV->repmgr_add_remote_site()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="repsync.html">Prev</a> </td>
<th width="60%" align="center">Chapter 10.
Replication Methods
</th>
<td width="20%" align="right"> <a accesskey="n" href="repmgrget_ack_policy.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="repmgrremote_site"></a>DB_ENV->repmgr_add_remote_site()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db.h>
int
DB_ENV->repmgr_add_remote_site(DB_ENV *env,
const char *host, u_int port, int *eidp, u_int32_t flags); </pre>
<p>
The <code class="methodname">DB_ENV->repmgr_add_remote_site()</code> method adds a new replication
site to the Replication Manager's list of known sites. It is not
necessary for all sites in a replication group to know about all other
sites in the group.
</p>
<p>
The database environment's replication subsystem may also be configured using the
environment's <a href="../../programmer_reference/env_db_config.html#env_db_config.DB_CONFIG" class="olink">DB_CONFIG</a> file. The
syntax of the entry in that file is a single line with the string "repmgr_add_remote_site",
one or more whitespace characters, and the
<span class="bold"><strong>host, port</strong></span> and optional
<span class="bold"><strong>peer</strong></span>
parameters specified. For example, "repmgr_add_remote_site example.com 49201 peer".
</p>
<p>
The <code class="methodname">DB_ENV->repmgr_add_remote_site()</code> method may be called at any time
during the life of the application.
</p>
<p>
The <code class="methodname">DB_ENV->repmgr_add_remote_site()</code> <span>
<span>
method returns a non-zero error value on failure and 0 on success.
</span>
</span>
</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp54038368"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp54047704"></a>host</h4>
</div>
</div>
</div>
<p>
The site's host identification string, generally a TCP/IP host name.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp54054824"></a>port</h4>
</div>
</div>
</div>
<p>
The port number on which the remote site is receiving.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp54055256"></a>eidp</h4>
</div>
</div>
</div>
<p>
If <span class="bold"><strong>eidp</strong></span> is non-NULL, and the database
environment has already been opened by calling
<a class="xref" href="envopen.html" title="DB_ENV->open()">DB_ENV->open()</a>, then the environment
ID assigned to the remote site is returned in the memory location
referenced by <span class="bold"><strong>eidp</strong></span>.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp54043472"></a>flags</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>flags</strong></span> parameter must be set to 0
or by bitwise inclusively <span class="bold"><strong>OR</strong></span>'ing
together one or more of the following values:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p>
<code class="literal">DB_REPMGR_PEER</code>
</p>
<p>
Specifying the <code class="literal">DB_REPMGR_PEER</code> flag configures client-to-client
synchronization with the specified remote site.
</p>
<p>
You can configure one or more remote sites as client peers. To
remove a remote site as a possible client peer, call the
<code class="methodname">DB_ENV->repmgr_add_remote_site()</code> method for that
site with a <span class="bold"><strong>flags</strong></span> value excluding
the DB_REPMGR_PEER bit value.
</p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp54057776"></a>Errors</h3>
</div>
</div>
</div>
<p>
The <code class="methodname">DB_ENV->repmgr_add_remote_site()</code>
<span>
<span>
method may fail and 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="idp54063664"></a>EINVAL</h4>
</div>
</div>
</div>
<p>
If this method is called from a base replication 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="idp54062584"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="env.html" title="Chapter 5. The DB_ENV Handle">DB_ENV</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp54064096"></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="repsync.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="repmgrget_ack_policy.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DB_ENV->rep_sync() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DB_ENV->repmgr_get_ack_policy()</td>
</tr>
</table>
</div>
</body>
</html>
|
