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

463 lines
17 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>ReplicationStatus (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="ReplicationStatus (Oracle - Berkeley DB Java API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":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/ReplicationStatus.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>Field&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>Field&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 ReplicationStatus" class="title">Class ReplicationStatus</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.sleepycat.db.ReplicationStatus</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public final class <span class="typeNameLabel">ReplicationStatus</span>
extends java.lang.Object</pre>
<div class="block">The return status from processing a replication message.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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><a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCData--">getCData</a></span>()</code></th>
<td class="colLast">
<div class="block">Whenever the system receives contact information from a new
environment, a copy of the opaque data specified in the cdata
parameter to the <a href="Environment.html#startReplication-com.sleepycat.db.DatabaseEntry-boolean-"><code>Environment.startReplication</code></a> is available
from the getCDAta method.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEnvID--">getEnvID</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the environment ID associated with the operation.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLSN--">getLSN</a></span>()</code></th>
<td class="colLast">
<div class="block">Whenever processing a messages results in the processing of messages
that are permanent, or a message carrying a DB_REP_PERMANENT flag
was processed successfully, but was not written to disk, the LSN of
the record is available from the getLSN method.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isIgnore--">isIgnore</a></span>()</code></th>
<td class="colLast">
<div class="block">This message cannot be processed.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isNewSite--">isNewSite</a></span>()</code></th>
<td class="colLast">
<div class="block">The system received contact information from a new environment.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isNotPermanent--">isNotPermanent</a></span>()</code></th>
<td class="colLast">
<div class="block">A message carrying a DB_REP_PERMANENT flag was processed successfully,
but was not written to disk.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isPermanent--">isPermanent</a></span>()</code></th>
<td class="colLast">
<div class="block">Processing this message resulted in the processing of records that
are permanent.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSuccess--">isSuccess</a></span>()</code></th>
<td class="colLast">
<div class="block">The operation succeeded.</div>
</td>
</tr>
<tr id="i8" 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">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="isSuccess--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSuccess</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isSuccess()</pre>
<div class="block">The operation succeeded.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>if the operation succeeded</dd>
</dl>
</li>
</ul>
<a name="isIgnore--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isIgnore</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isIgnore()</pre>
<div class="block">This message cannot be processed.
This is an indication that this message is irrelevant to the current
replication state (for example, an old message from a previous
generation arrives and is processed late).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>if the message cannot be processed</dd>
</dl>
</li>
</ul>
<a name="isPermanent--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPermanent</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isPermanent()</pre>
<div class="block">Processing this message resulted in the processing of records that
are permanent. The maximum LSN of the permanent records stored is
available from the getLSN method.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>if the message is a permanent message</dd>
</dl>
</li>
</ul>
<a name="isNewSite--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isNewSite</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isNewSite()</pre>
<div class="block">The system received contact information from a new environment. A
copy of the opaque data specified in the cdata parameter to the
<a href="Environment.html#startReplication-com.sleepycat.db.DatabaseEntry-boolean-"><code>Environment.startReplication</code></a> is available from the
getCDAta method. The application should take whatever action is
needed to establish a communication channel with this new
environment.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>if the system received contact information from a new environment</dd>
</dl>
</li>
</ul>
<a name="isNotPermanent--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isNotPermanent</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isNotPermanent()</pre>
<div class="block">A message carrying a DB_REP_PERMANENT flag was processed successfully,
but was not written to disk. The LSN of this record is available from
the getLSN method. The application should take whatever action is
deemed necessary to retain its recoverability characteristics.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>if a permanent message was not written to disk</dd>
</dl>
</li>
</ul>
<a name="getCData--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCData</h4>
<pre class="methodSignature">public&nbsp;<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a>&nbsp;getCData()</pre>
<div class="block">Whenever the system receives contact information from a new
environment, a copy of the opaque data specified in the cdata
parameter to the <a href="Environment.html#startReplication-com.sleepycat.db.DatabaseEntry-boolean-"><code>Environment.startReplication</code></a> is available
from the getCDAta method. The application should take whatever
action is needed to establish a communication channel with this new
environment.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the opaque data received from a new environment</dd>
</dl>
</li>
</ul>
<a name="getEnvID--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEnvID</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getEnvID()</pre>
<div class="block">Return the environment ID associated with the operation. In most cases,
this is the same as the environment ID passed to <a href="Environment.html#processReplicationMessage-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-int-"><code>Environment.processReplicationMessage</code></a>. However, if a new master is elected, this
method returns the environment ID of the new master. It is the
application's responsibility to ensure that the matching node begins acting
as the master environment.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the environment ID</dd>
</dl>
</li>
</ul>
<a name="getLSN--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLSN</h4>
<pre class="methodSignature">public&nbsp;<a href="LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</a>&nbsp;getLSN()</pre>
<div class="block">Whenever processing a messages results in the processing of messages
that are permanent, or a message carrying a DB_REP_PERMANENT flag
was processed successfully, but was not written to disk, the LSN of
the record is available from the getLSN method. The application
should take whatever action is deemed necessary to retain its
recoverability characteristics.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the LSN of the last processed permanent message</dd>
</dl>
</li>
</ul>
<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/ReplicationStatus.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>Field&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>Field&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>