Files
Yasuhiro KIMURA 9678929700 Update to 18.1.40
2020-07-24 01:10:28 +09:00

575 lines
23 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.7) on Mon Jun 01 06:40:53 PDT 2020 -->
<title>ReplicationConfig (Oracle - Berkeley DB Java API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="date" content="2020-06-01">
<link rel="stylesheet" type="text/css" href="../../../style.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../jquery/jquery-3.4.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ReplicationConfig (Oracle - Berkeley DB Java API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ReplicationConfig.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Berkeley DB</b><br><font size="-1"> version 18.1.40</font></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.sleepycat.db</a></div>
<h2 title="Class ReplicationConfig" class="title">Class ReplicationConfig</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.sleepycat.db.ReplicationConfig</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.lang.Cloneable</code></dd>
</dl>
<hr>
<pre>public final class <span class="typeNameLabel">ReplicationConfig</span>
extends java.lang.Object
implements java.lang.Cloneable</pre>
<div class="block">Settings that configure Berkeley DB replication. Used in the <a href="Environment.html#setReplicationConfig-com.sleepycat.db.ReplicationConfig-boolean-"><code>Environment.setReplicationConfig(com.sleepycat.db.ReplicationConfig, boolean)</code></a> method.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#AUTOINIT">AUTOINIT</a></span></code></th>
<td class="colLast">
<div class="block">The replication master should automatically re-initialize outdated
clients (defaults to on.)</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#BULK">BULK</a></span></code></th>
<td class="colLast">
<div class="block">The replication master should send groups of records to the clients in a
single network transfer.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DELAYCLIENT">DELAYCLIENT</a></span></code></th>
<td class="colLast">
<div class="block">The client should delay synchronizing to a newly declared master
(defaults to off).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DISABLE_POLL">DISABLE_POLL</a></span></code></th>
<td class="colLast">
<div class="block">This flag is used to prevent the use of poll() as polling method for
networking events on the target site.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DISABLE_SSL">DISABLE_SSL</a></span></code></th>
<td class="colLast">
<div class="block">This flag is used to prevent the use of SSL for securing messages shared
between the nodes of a replication group.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ELECTIONS">ELECTIONS</a></span></code></th>
<td class="colLast">
<div class="block">Replication Manager automatically runs elections to choose a new
master when the old master appears to have become disconnected.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ENABLE_EPOLL">ENABLE_EPOLL</a></span></code></th>
<td class="colLast">
<div class="block">This flag is used to force the use of epoll as polling method for
networking events instad of poll or select.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#FORWARD_WRITES">FORWARD_WRITES</a></span></code></th>
<td class="colLast">
<div class="block">Enable simple write forwarding for this site.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#LEASE">LEASE</a></span></code></th>
<td class="colLast">
<div class="block">Master leases will be used for this site.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#NOWAIT">NOWAIT</a></span></code></th>
<td class="colLast">
<div class="block">Berkeley DB method calls that would normally block while clients are in
recovery should return errors immediately.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PREFMAS_CLIENT">PREFMAS_CLIENT</a></span></code></th>
<td class="colLast">
<div class="block">This flag is used to specify the client site in a replication group
operating in preferred master mode.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PREFMAS_MASTER">PREFMAS_MASTER</a></span></code></th>
<td class="colLast">
<div class="block">This flag is used to specify the preferred master site in a replication
group operating in preferred master mode.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#STRICT_2SITE">STRICT_2SITE</a></span></code></th>
<td class="colLast">
<div class="block">Replication Manager observes the strict "majority" rule in managing
elections, even in a group with only 2 sites.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString--">toString</a></span>()</code></th>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="BULK">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BULK</h4>
<pre>public static final&nbsp;<a href="ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a> BULK</pre>
<div class="block">The replication master should send groups of records to the clients in a
single network transfer.</div>
</li>
</ul>
<a name="DELAYCLIENT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DELAYCLIENT</h4>
<pre>public static final&nbsp;<a href="ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a> DELAYCLIENT</pre>
<div class="block">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="Environment.html#syncReplication--"><code>Environment.syncReplication()</code></a> method.</div>
</li>
</ul>
<a name="AUTOINIT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>AUTOINIT</h4>
<pre>public static final&nbsp;<a href="ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a> AUTOINIT</pre>
<div class="block">The replication master should automatically re-initialize outdated
clients (defaults to on.)</div>
</li>
</ul>
<a name="NOWAIT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NOWAIT</h4>
<pre>public static final&nbsp;<a href="ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a> NOWAIT</pre>
<div class="block">Berkeley DB method calls that would normally block while clients are in
recovery should return errors immediately.</div>
</li>
</ul>
<a name="STRICT_2SITE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>STRICT_2SITE</h4>
<pre>public static final&nbsp;<a href="ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a> STRICT_2SITE</pre>
<div class="block">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="../../../../programmer_reference/rep_elect.html" target="_top">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.</div>
</li>
</ul>
<a name="DISABLE_POLL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DISABLE_POLL</h4>
<pre>public static final&nbsp;<a href="ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a> DISABLE_POLL</pre>
<div class="block">This flag is used to prevent the use of poll() as polling method for
networking events on the target site. This flag guarantees that instead
of poll() select or epoll() would be used depending on the availablity
of these methods on the target platform and additional flags provided to
repmgr.</div>
</li>
</ul>
<a name="DISABLE_SSL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DISABLE_SSL</h4>
<pre>public static final&nbsp;<a href="ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a> DISABLE_SSL</pre>
<div class="block">This flag is used to prevent the use of SSL for securing messages shared
between the nodes of a replication group.</div>
</li>
</ul>
<a name="ELECTIONS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ELECTIONS</h4>
<pre>public static final&nbsp;<a href="ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a> ELECTIONS</pre>
<div class="block">Replication Manager automatically runs elections to choose a new
master when the old master appears to have become disconnected.
This option is turned on by default.</div>
</li>
</ul>
<a name="ENABLE_EPOLL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ENABLE_EPOLL</h4>
<pre>public static final&nbsp;<a href="ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a> ENABLE_EPOLL</pre>
<div class="block">This flag is used to force the use of epoll as polling method for
networking events instad of poll or select. Use of this flag does
not guarantee that epoll will be used though. It depends on the
availability of epoll on target platform. Epoll is supposed to be
used only when the expected number of connections for repmgr is
greater than 1000.</div>
</li>
</ul>
<a name="LEASE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LEASE</h4>
<pre>public static final&nbsp;<a href="ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a> LEASE</pre>
<div class="block">Master leases will be used for this site.
<p>
Configuring this option may result in the <a href="Database.html#get-com.sleepycat.db.Transaction-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-"><code>Database.get()</code></a>
and <a href="Cursor.html" title="class in com.sleepycat.db"><code>Cursor.get*()</code></a> methods throwing a
<a href="DatabaseException.html" title="class in com.sleepycat.db"><code>DatabaseException</code></a> when attempting to read entries from a database
after the site's master lease has expired.
<p>
Once this option is turned on, it may never be turned off.</div>
</li>
</ul>
<a name="PREFMAS_MASTER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PREFMAS_MASTER</h4>
<pre>public static final&nbsp;<a href="ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a> PREFMAS_MASTER</pre>
<div class="block">This flag is used to specify the preferred master site in a replication
group operating in preferred master mode. A preferred master replication
group must contain only two sites, with one site specified as the preferred
master site and the other site specified as the client site. The preferred
master site operates as the master site whenever possible.</div>
</li>
</ul>
<a name="PREFMAS_CLIENT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PREFMAS_CLIENT</h4>
<pre>public static final&nbsp;<a href="ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a> PREFMAS_CLIENT</pre>
<div class="block">This flag is used to specify the client site in a replication group
operating in preferred master mode. A preferred master replication group
must contain only two sites, with one site specified as the preferred
master site and the other site specified as the client site. The client
site in a preferred master replication group takes over temporarily as
master when the preferred master site is unavailable.</div>
</li>
</ul>
<a name="FORWARD_WRITES">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FORWARD_WRITES</h4>
<pre>public static final&nbsp;<a href="ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a> FORWARD_WRITES</pre>
<div class="block">Enable simple write forwarding for this site. This option is turned off by default.
<p>
By default, write operations cannot be performed on a replication client site.
This option enables forwarding of simple client database put and delete operations
to the master site for processing. These operations must use an implicit
NULL transaction ID to be forwarded. Any other write operation that
specifies a non-NULL transaction throws a DatabaseException.
</p>
<p>
The master must have an open database handle for the database on which a forwarded
write operation is being performed.
</p>
<p>
All sites in the replication group should have the same value for this configuration option.
</p></div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ReplicationConfig.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Berkeley DB</b><br><font size="-1"> version 18.1.40</font></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><font size=1>Copyright (c) 1996, 2020 Oracle and/or its affiliates. All rights reserved.</font></small></p>
</body>
</html>