libdb/docs/api_reference/C/repnsites.html
2012-11-14 16:35:20 -05:00

186 lines
7.5 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?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-&gt;rep_set_nsites()</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="repset_limit.html" title="DB_ENV-&gt;rep_set_limit()" />
<link rel="next" href="reppriority.html" title="DB_ENV-&gt;rep_set_priority()" />
</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">DB_ENV-&gt;rep_set_nsites()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="repset_limit.html">Prev</a> </td>
<th width="60%" align="center">Chapter 10. 
Replication Methods
</th>
<td width="20%" align="right"> <a accesskey="n" href="reppriority.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="repnsites"></a>DB_ENV-&gt;rep_set_nsites()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include &lt;db.h&gt;
int
DB_ENV-&gt;rep_set_nsites(DB_ENV *env, u_int32_t nsites); </pre>
<p>
The <code class="methodname">DB_ENV-&gt;rep_set_nsites()</code> method specifies the total number of
sites in a replication group. This method should not be used by
Replication Manager applications; the number of sites in use by a
Replication Manager application is determined dynamically.
</p>
<p>
The <code class="methodname">DB_ENV-&gt;rep_set_nsites()</code> method is typically called by
Base API applications. (However, see also the
<a class="xref" href="repelect.html" title="DB_ENV-&gt;rep_elect()">DB_ENV-&gt;rep_elect()</a> method
<span class="bold"><strong>nsites</strong></span>
parameter.)
</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
"rep_set_nsites", one or more whitespace characters, and the
number of sites specified. For example, "rep_set_nsites 5" sets
the number of sites to 5. Because the <a href="../../programmer_reference/env_db_config.html#env_db_config.DB_CONFIG" class="olink">DB_CONFIG</a> file is read
when the database environment is opened, it will silently overrule
configuration done before that time.
</p>
<p>
The <code class="methodname">DB_ENV-&gt;rep_set_nsites()</code> method configures a database
environment, not only operations performed using the specified
<a class="link" href="env.html" title="Chapter 5.  The DB_ENV Handle">DB_ENV</a> handle.
</p>
<p>
If master leases are in use, the <code class="methodname">DB_ENV-&gt;rep_set_nsites()</code> method
should not be called after the <a class="xref" href="repstart.html" title="DB_ENV-&gt;rep_start()">DB_ENV-&gt;rep_start()</a>
method is called as this could cause you to lose data previously
thought to be durable. If master leases are not in use, the
<code class="methodname">DB_ENV-&gt;rep_set_nsites()</code> method may be
called at any time during the life of the application.
</p>
<p>
The <code class="methodname">DB_ENV-&gt;rep_set_nsites()</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="idp62114184"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp62113280"></a>nsites</h4>
</div>
</div>
</div>
<p>
An integer specifying the total number of sites in the replication
group.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp62115040"></a>Errors</h3>
</div>
</div>
</div>
<p>
The <code class="methodname">DB_ENV-&gt;rep_set_nsites()</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="idp62113600"></a>EINVAL</h4>
</div>
</div>
</div>
<p>
If master leases are in use and replication has already been started; 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="idp62082880"></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="idp62121656"></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="repset_limit.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="reppriority.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DB_ENV-&gt;rep_set_limit() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DB_ENV-&gt;rep_set_priority()</td>
</tr>
</table>
</div>
</body>
</html>