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
|
<?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>DbSite::set_config()</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="dbsite_remove.html" title="DbSite::remove()" />
<link rel="next" href="repelect.html" title="DbEnv::rep_elect()" />
</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">DbSite::set_config()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="dbsite_remove.html">Prev</a> </td>
<th width="60%" align="center">Chapter 11.
Replication Methods
</th>
<td width="20%" align="right"> <a accesskey="n" href="repelect.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="dbsite_set_config"></a>DbSite::set_config()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db_cxx.h>
int
DbSite::set_config(u_int32_t which, u_int32_t value);</pre>
<p>
The <code class="methodname">DbSite::set_config()</code> method configures
a Replication Manager site.
</p>
<p>
The <code class="methodname">DbSite::set_config()</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>
<p>
The Replication Manager site may also be configured using the
environment's DB_CONFIG file. The syntax of the entry in that file
is described in
<a class="xref" href="repmgr_site_parameter.html" title="repmgr_site">repmgr_site</a>.
</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp9419696"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp9419888"></a>which</h4>
</div>
</div>
</div>
<p>
This parameter must be set to one of the following
values:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p><a id="DB_BOOTSTRAP_HELPER"></a>
<code class="literal">DB_BOOTSTRAP_HELPER</code>
</p>
<p>
Specifies that a remote site may be used as a
"helper" when the local site is first joining the
replication group. Once the local site has been
established as a member of the group, this
setting is ignored.
</p>
</li>
<li>
<p><a id="DB_GROUP_CREATOR"></a>
<code class="literal">DB_GROUP_CREATOR</code>
</p>
<p>
Specifies that this site should create the
initial membership database contents, defining a
"group" of just the one site, rather than trying to
join an existing group when it starts for the first
time.
</p>
<p>
This setting can only be used on the local site and
is ignored when configured for a remote site.
</p>
</li>
<li>
<p><a id="DB_LEGACY"></a>
<code class="literal">DB_LEGACY</code>
</p>
<p>
Specifies that the site is already part of an
existing group. This setting causes the site to be
upgraded from a previous version of BDB. All sites
in the legacy group must specify this setting for
themselves (the local site) and for all other sites
currently existing in the group. Once the upgrade
has been completed, this setting is no longer
required.
</p>
</li>
<li>
<p><a id="DB_LOCAL_SITE"></a>
<code class="literal">DB_LOCAL_SITE</code>
</p>
<p>
Specifies that this site is the local site within
the replication group. The application must
identify exactly one site as the local site in this
way, before calling the
<a class="xref" href="repmgrstart.html" title="DbEnv::repmgr_start()">DbEnv::repmgr_start()</a>
method.
</p>
</li>
<li>
<p><a id="DB_REPMGR_PEER"></a>
<code class="literal">DB_REPMGR_PEER</code>
</p>
<p>
Specifies that the site may be used as a target for
"client-to-client" synchronization messages. This
setting is ignored if it is specified for the local
site.
</p>
</li>
</ul>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp9426272"></a>value</h4>
</div>
</div>
</div>
<p>
If <code class="literal">0</code>, the parameter identified by the <span class="bold"><strong>which</strong></span> is turned off. Otherwise,
it is turned on.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp9427352"></a>Errors</h3>
</div>
</div>
</div>
<p>
The <code class="methodname">DbSite::set_config()</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="idp9435072"></a>EINVAL</h4>
</div>
</div>
</div>
<p>
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="idp9421024"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="db_site.html" title="The DbSite Handle">DbSite</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp9428032"></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="dbsite_remove.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="repelect.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DbSite::remove() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DbEnv::rep_elect()</td>
</tr>
</table>
</div>
</body>
</html>
|