Edit File - File Manager

Edit File: rep_config.html

<html>
<head>
<title>Berkeley DB: DB_ENV-&gt;rep_set_config</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
</head>
<body bgcolor=white>
<table width="100%"><tr valign=top>
<td>
DB_ENV-&gt;rep_set_config
</td>
<td align=right>
<a href="../../db4-devel-4.7.25/api_c/api_core.html"><img src="../../db4-devel-4.7.25/images/api.gif" alt="API"></a>
<a href="../../db4-devel-4.7.25/ref/toc.html"><img src="../../db4-devel-4.7.25/images/ref.gif" alt="Ref"></a></td>
</tr></table>
<hr size=1 noshade>
<tt>
<pre>
#include &lt;db.h&gt;

int
DB_ENV-&gt;rep_set_config(DB_ENV *env, u_int32_t which, int onoff);

int
DB_ENV-&gt;rep_get_config(DB_ENV *dbenv, u_int32_t which, int *onoffp);
</pre>
<hr size=1 noshade>
Description: DB_ENV-&gt;rep_set_config
The DB_ENV-&gt;rep_set_config method method configures the Berkeley DB replication
subsystem.
The database environment's replication subsystem may also be configured using the
environment's <a href="../../db4-devel-4.7.25/ref/env/db_config.html#DB_CONFIG">DB_CONFIG</a> file. The syntax of the entry in that
file is a single line with the string "rep_set_config", one or more whitespace
characters, and the method which parameter as a string; for example,
"rep_set_config DB_REP_CONF_NOWAIT".
Because the <a href="../../db4-devel-4.7.25/ref/env/db_config.html#DB_CONFIG">DB_CONFIG</a> file is read when the database environment
is opened, it will silently overrule configuration done before that
time.
The DB_ENV-&gt;rep_set_config method configures a database environment, not only operations
performed using the specified <a href="../../db4-devel-4.7.25/api_c/env_class.html">DB_ENV</a> handle.
The DB_ENV-&gt;rep_set_config method may be called at any time during the life of the
application.
The DB_ENV-&gt;rep_set_config method
returns a non-zero error value on failure
and 0 on success.

Parameters 
 onoff<ul compact><li>If the onoff parameter is zero, the configuration flag is turned
off. Otherwise, it is turned on.</ul>
 which<ul compact><li>The which parameter must be set to one of the following values:
 
<a name="DB_REP_CONF_BULK">DB_REP_CONF_BULK</a><ul compact><li>The replication master sends groups of records to the clients in a
single network transfer (defaults to off).</ul>
<a name="DB_REP_CONF_DELAYCLIENT">DB_REP_CONF_DELAYCLIENT</a><ul compact><li>The client should delay synchronizing to a newly declared master
(defaults to off). Clients configured in this way will remain
unsynchronized until the application calls the <a href="../../db4-devel-4.7.25/api_c/rep_sync.html">DB_ENV-&gt;rep_sync</a> method.</ul>
<a name="DB_REP_CONF_LEASE">DB_REP_CONF_LEASE</a><ul compact><li>Master leases will be used for this site (defaults to off).
Configuring this option may result in <a name="DB_REP_LEASE_EXPIRED">DB_REP_LEASE_EXPIRED</a>
error returns from the <a href="../../db4-devel-4.7.25/api_c/db_get.html">DB-&gt;get</a> and <a href="../../db4-devel-4.7.25/api_c/dbc_get.html">DBcursor-&gt;get</a> methods when
attempting to read entries from a database after the site's master lease
has expired.
The DB_ENV-&gt;rep_set_config method may not be called after the <a href="../../db4-devel-4.7.25/api_c/repmgr_start.html">DB_ENV-&gt;repmgr_start</a> or <a href="../../db4-devel-4.7.25/api_c/rep_start.html">DB_ENV-&gt;rep_start</a> methods are
called.
Once this option is turned on, it may never be turned off.</ul>
<a name="DB_REP_CONF_NOAUTOINIT">DB_REP_CONF_NOAUTOINIT</a><ul compact><li>The replication master will not automatically re-initialize outdated
clients (defaults to off).</ul>
<a name="DB_REP_CONF_NOWAIT">DB_REP_CONF_NOWAIT</a><ul compact><li>Berkeley DB method calls that would normally block while clients are in
recovery will return errors immediately (defaults to off).</ul>
<a name="DB_REPMGR_CONF_2SITE_STRICT">DB_REPMGR_CONF_2SITE_STRICT</a><ul compact><li>Replication Manager observes the strict "majority" rule in managing
elections, even in a group with only 2 sites. This means the client in
a 2-site group will be unable to take over as master if the original
master fails or becomes disconnected. (See the
<a href="../../db4-devel-4.7.25/ref/rep/elect.html">Elections</a> section in the Berkeley DB
Reference Guide for more information.) Both sites in the replication
group should have the same value for this parameter.</ul>
 </ul>
 
 Errors
The DB_ENV-&gt;rep_set_config method
may fail and return one of the following non-zero errors:
 
EINVAL<ul compact><li>An
invalid flag value or parameter was specified.</ul>
 
<hr size=1 noshade>
Description: DB_ENV-&gt;rep_get_config
The DB_ENV-&gt;rep_get_config method returns whether the specified which
parameter is currently set or not.
The DB_ENV-&gt;rep_get_config method may be called at any time during the life of the
application.
The DB_ENV-&gt;rep_get_config method
returns a non-zero error value on failure
and 0 on success.

Parameters 
 which<ul compact><li>The which parameter is the message value for which configuration
is being checked.</ul>
 onoffp<ul compact><li>The onoffp parameter references memory into which
 the configuration of the specified which parameter is copied.</ul> If the returned onoff value is zero, the parameter is off;
otherwise on.
 
<hr size=1 noshade>
 Class
<a href="../../db4-devel-4.7.25/api_c/env_class.html">DB_ENV</a>
 See Also
<a href="../../db4-devel-4.7.25/api_c/rep_list.html">Replication and Related Methods</a>
</tt>
<table width="100%"><tr><td> </td><td align=right>
<a href="../../db4-devel-4.7.25/api_c/api_core.html"><img src="../../db4-devel-4.7.25/images/api.gif" alt="API"></a><a href="../../db4-devel-4.7.25/ref/toc.html"><img src="../../db4-devel-4.7.25/images/ref.gif" alt="Ref"></a>
</td></tr></table>
Copyright (c) 1996,2008 Oracle. All rights reserved.
</body>
</html>

Back to File Manager