summaryrefslogtreecommitdiff
path: root/docs/api_reference/C/repmgrstart.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/api_reference/C/repmgrstart.html')
-rw-r--r--docs/api_reference/C/repmgrstart.html48
1 files changed, 28 insertions, 20 deletions
diff --git a/docs/api_reference/C/repmgrstart.html b/docs/api_reference/C/repmgrstart.html
index 6a079770..5be09299 100644
--- a/docs/api_reference/C/repmgrstart.html
+++ b/docs/api_reference/C/repmgrstart.html
@@ -14,7 +14,7 @@
<body>
<div xmlns="" class="navheader">
<div class="libver">
- <p>Library Version 11.2.5.3</p>
+ <p>Library Version 12.1.6.1</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
@@ -60,14 +60,14 @@ DB_ENV-&gt;repmgr_start(DB_ENV *env, int nthreads, u_int32_t flags); </pre>
<p>
Use <a class="xref" href="repmgr_site.html" title="DB_ENV-&gt;repmgr_site()">DB_ENV-&gt;repmgr_site()</a>
to obtain a DB_SITE handle, then use that handle to
- configure the sites in your replication group.
+ configure the sites in the replication group.
</p>
<div class="orderedlist">
<ol type="a">
<li>
<p>
Use <a class="xref" href="dbsite_set_config.html" title="DB_SITE-&gt;set_config()">DB_SITE-&gt;set_config()</a>
- to configure sites in your replication group.
+ to configure sites in the replication group.
</p>
</li>
<li>
@@ -120,17 +120,20 @@ DB_ENV-&gt;repmgr_start(DB_ENV *env, int nthreads, u_int32_t flags); </pre>
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">DB_ENV-&gt;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.
+ first process to call it, and skips this step in the later calls from
+ other subordinate processes.
</p>
<p>
The <code class="methodname">DB_ENV-&gt;repmgr_start()</code> method
may not be called before the <a class="xref" href="envopen.html" title="DB_ENV-&gt;open()">DB_ENV-&gt;open()</a> method is
- called to open. In addition, this method may not be called before
- your replication sites have been configured using the
+ called to open the environment. In addition, this method may not be called before
+ at least one replication site has been configured using the
<a class="link" href="db_site.html" title="The DB_SITE Handle">DB_SITE</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.
+ flag set. If you are starting a view, you must call the
+ <a class="xref" href="repset_view.html" title="DB_ENV-&gt;rep_set_view()">DB_ENV-&gt;rep_set_view()</a>
+ method before opening the local environment.
</p>
<p>
The <code class="methodname">DB_ENV-&gt;repmgr_start()</code> method will return
@@ -149,7 +152,7 @@ DB_ENV-&gt;repmgr_start(DB_ENV *env, int nthreads, u_int32_t flags); </pre>
<div class="titlepage">
<div>
<div>
- <h3 class="title"><a id="idp62445408"></a>Parameters</h3>
+ <h3 class="title"><a id="idp4198872"></a>Parameters</h3>
</div>
</div>
</div>
@@ -157,7 +160,7 @@ DB_ENV-&gt;repmgr_start(DB_ENV *env, int nthreads, u_int32_t flags); </pre>
<div class="titlepage">
<div>
<div>
- <h4 class="title"><a id="idp62446056"></a>nthreads</h4>
+ <h4 class="title"><a id="idp4201592"></a>nthreads</h4>
</div>
</div>
</div>
@@ -175,7 +178,7 @@ DB_ENV-&gt;repmgr_start(DB_ENV *env, int nthreads, u_int32_t flags); </pre>
<div class="titlepage">
<div>
<div>
- <h4 class="title"><a id="idp62437808"></a>flags</h4>
+ <h4 class="title"><a id="idp4193560"></a>flags</h4>
</div>
</div>
</div>
@@ -202,7 +205,8 @@ DB_ENV-&gt;repmgr_start(DB_ENV *env, int nthreads, u_int32_t flags); </pre>
<code class="literal">DB_REP_CLIENT</code>
</p>
<p>
- Start as a client site, and do not call for an election.
+ Start as a client, view, or preferred master site, and do not
+ call for an election.
</p>
</li>
<li>
@@ -219,7 +223,8 @@ DB_ENV-&gt;repmgr_start(DB_ENV *env, int nthreads, u_int32_t flags); </pre>
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>.
+ value of <span class="bold"><strong>nthreads</strong></span>
+ or when starting a subordinate process.
</p>
</div>
</div>
@@ -227,7 +232,7 @@ DB_ENV-&gt;repmgr_start(DB_ENV *env, int nthreads, u_int32_t flags); </pre>
<div class="titlepage">
<div>
<div>
- <h3 class="title"><a id="idp62441936"></a>Errors</h3>
+ <h3 class="title"><a id="idp4197688"></a>Errors</h3>
</div>
</div>
</div>
@@ -243,14 +248,14 @@ DB_ENV-&gt;repmgr_start(DB_ENV *env, int nthreads, u_int32_t flags); </pre>
<div class="titlepage">
<div>
<div>
- <h4 class="title"><a id="idp62459432"></a>DB_REP_UNAVAIL</h4>
+ <h4 class="title"><a id="idp4216064"></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
+ or because insufficient clients are running to acknowledge
the new site). When that happens the application should
pause and retry adding the site until it completes
successfully.
@@ -260,7 +265,7 @@ DB_ENV-&gt;repmgr_start(DB_ENV *env, int nthreads, u_int32_t flags); </pre>
<div class="titlepage">
<div>
<div>
- <h4 class="title"><a id="idp62446544"></a>EINVAL</h4>
+ <h4 class="title"><a id="idp4203592"></a>EINVAL</h4>
</div>
</div>
</div>
@@ -268,8 +273,11 @@ DB_ENV-&gt;repmgr_start(DB_ENV *env, int nthreads, u_int32_t flags); </pre>
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.
+ from a Base API application; a view is being started without
+ having called the
+ <a class="xref" href="repset_view.html" title="DB_ENV-&gt;rep_set_view()">DB_ENV-&gt;rep_set_view()</a>
+ method before opening the database environment; or if an
+ invalid flag value or parameter was specified.
</p>
</div>
</div>
@@ -277,7 +285,7 @@ DB_ENV-&gt;repmgr_start(DB_ENV *env, int nthreads, u_int32_t flags); </pre>
<div class="titlepage">
<div>
<div>
- <h3 class="title"><a id="idp62447048"></a>Class</h3>
+ <h3 class="title"><a id="idp4217144"></a>Class</h3>
</div>
</div>
</div>
@@ -289,7 +297,7 @@ DB_ENV-&gt;repmgr_start(DB_ENV *env, int nthreads, u_int32_t flags); </pre>
<div class="titlepage">
<div>
<div>
- <h3 class="title"><a id="idp62456376"></a>See Also</h3>
+ <h3 class="title"><a id="idp4212792"></a>See Also</h3>
</div>
</div>
</div>