2011-09-13 17:44:24 +00:00
<?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::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 11. Replication Methods" / >
< link rel = "prev" href = "repset_limit.html" title = "DbEnv::rep_set_limit()" / >
< link rel = "next" href = "reppriority.html" title = "DbEnv::rep_set_priority()" / >
< / head >
< body >
< div xmlns = "" class = "navheader" >
< div class = "libver" >
< p > Library Version 11.2.5.2< / p >
< / div >
< table width = "100%" summary = "Navigation header" >
< tr >
< th colspan = "3" align = "center" > DbEnv::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 11.
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 > DbEnv::rep_set_nsites()< / h2 >
< / div >
< / div >
< / div >
< pre class = "programlisting" > #include < db_cxx.h>
int
DbEnv::rep_set_nsites(u_int32_t nsites); < / pre >
< p >
The < code class = "methodname" > DbEnv::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" > DbEnv::rep_set_nsites()< / code > method is typically called by
Base API applications. (However, see also the
< a class = "xref" href = "repelect.html" title = "DbEnv::rep_elect()" > DbEnv::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" > DbEnv::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 DbEnv Handle" > DbEnv< / a > handle.
< / p >
< p >
If master leases are in use, the < code class = "methodname" > DbEnv::rep_set_nsites()< / code > method
should not be called after the < a class = "xref" href = "repstart.html" title = "DbEnv::rep_start()" > DbEnv::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" > DbEnv::rep_set_nsites()< / code > method may be
called at any time during the life of the application.
< / p >
< p >
The < code class = "methodname" > DbEnv::rep_set_nsites()< / 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 >
2011-12-20 00:07:10 +00:00
< h3 class = "title" > < a id = "id3640680" > < / a > Parameters< / h3 >
2011-09-13 17:44:24 +00:00
< / div >
< / div >
< / div >
< div class = "sect3" lang = "en" xml:lang = "en" >
< div class = "titlepage" >
< div >
< div >
2011-12-20 00:07:10 +00:00
< h4 class = "title" > < a id = "id3640669" > < / a > nsites< / h4 >
2011-09-13 17:44:24 +00:00
< / 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 >
2011-12-20 00:07:10 +00:00
< h3 class = "title" > < a id = "id3640695" > < / a > Errors< / h3 >
2011-09-13 17:44:24 +00:00
< / div >
< / div >
< / div >
< p >
The < code class = "methodname" > DbEnv::rep_set_nsites()< / 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 >
2011-12-20 00:07:10 +00:00
< h4 class = "title" > < a id = "id3640846" > < / a > EINVAL< / h4 >
2011-09-13 17:44:24 +00:00
< / 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 >
2011-12-20 00:07:10 +00:00
< h3 class = "title" > < a id = "id3640828" > < / a > Class< / h3 >
2011-09-13 17:44:24 +00:00
< / 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 >
2011-12-20 00:07:10 +00:00
< h3 class = "title" > < a id = "id3640163" > < / a > See Also< / h3 >
2011-09-13 17:44:24 +00:00
< / 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" > DbEnv::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" > DbEnv::rep_set_priority()< / td >
< / tr >
< / table >
< / div >
< / body >
< / html >