stasis/je-7.5.11/docs/java/com/sleepycat/je/rep/NodeState.html
2019-06-25 16:12:40 -04:00

521 lines
19 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 (1.8.0_151) on Tue Oct 31 17:36:46 EDT 2017 -->
<title>NodeState (Oracle - Berkeley DB Java Edition API)</title>
<meta name="date" content="2017-10-31">
<link rel="stylesheet" type="text/css" href="../../../../style.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="NodeState (Oracle - Berkeley DB Java Edition API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= 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="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/NodeState.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 Java Edition</b><br><font size=\"-1\"> version 7.5.11</font>
</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/sleepycat/je/rep/NoConsistencyRequiredPolicy.html" title="class in com.sleepycat.je.rep"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/sleepycat/je/rep/NodeType.html" title="enum in com.sleepycat.je.rep"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/sleepycat/je/rep/NodeState.html" target="_top">Frames</a></li>
<li><a href="NodeState.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></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>
</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 ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.sleepycat.je.rep</div>
<h2 title="Class NodeState" class="title">Class NodeState</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.sleepycat.je.rep.NodeState</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">NodeState</span>
extends java.lang.Object</pre>
<div class="block">The current state of a replication node and the application this node is
running in.
<p>
This includes the following information:
<p>
<ul>
<li>the replication <a href="../../../../com/sleepycat/je/rep/ReplicatedEnvironment.State.html" title="enum in com.sleepycat.je.rep"><code>state</code></a> of this
node</li>
<li>the name of the current master, as known by this node</li>
<li>the time when this node joined the replication group</li>
<li>the latest transaction end (abort or commit) VLSN on this node</li>
<li>the transaction end (abort or commit) VLSN on the master known by this
node. The difference between transaction end VLSNs on the master versus on
this node gives an indication of how current this node's data is. The gap
in VLSN values indicates the number of replication records that must be
processed by this node, to be caught up to the master.</li>
<li>the number of feeders running on this node</li>
<li>the system load average for the last minute</li>
<li>
The appState field is a byte array meant to hold information generated by
the JE HA application, as provided by a registered <a href="../../../../com/sleepycat/je/rep/AppStateMonitor.html" title="interface in com.sleepycat.je.rep"><code>AppStateMonitor</code></a>.
Users are responsible for serializing and deserializing information for this
field.</li>
</ul></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>5.0</dd>
</dl>
</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" border="0" cellpadding="3" cellspacing="0" 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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/NodeState.html#getActiveFeeders--">getActiveFeeders</a></span>()</code>
<div class="block">Returns the number of current active Feeders running on this node.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/NodeState.html#getAppState--">getAppState</a></span>()</code>
<div class="block">Returns the application state which is obtained via
<a href="../../../../com/sleepycat/je/rep/AppStateMonitor.html#getAppState--"><code>AppStateMonitor.getAppState()</code></a>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/NodeState.html#getCurrentTxnEndVLSN--">getCurrentTxnEndVLSN</a></span>()</code>
<div class="block">Returns the latest transaction end VLSN on this replication node.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/NodeState.html#getGroupName--">getGroupName</a></span>()</code>
<div class="block">Returns the name of the group which the node joins.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../com/sleepycat/je/JEVersion.html" title="class in com.sleepycat.je">JEVersion</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/NodeState.html#getJEVersion--">getJEVersion</a></span>()</code>
<div class="block">Returns the current JEVersion that this node runs on.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/NodeState.html#getJoinTime--">getJoinTime</a></span>()</code>
<div class="block">Returns the time when this node joins the replication group.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/NodeState.html#getKnownMasterTxnEndVLSN--">getKnownMasterTxnEndVLSN</a></span>()</code>
<div class="block">Returns the transaction end VLSN on the master known by this node.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/NodeState.html#getLogVersion--">getLogVersion</a></span>()</code>
<div class="block">Returns the log version of this node.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/NodeState.html#getMasterName--">getMasterName</a></span>()</code>
<div class="block">Returns the name of the current
<a href="../../../../com/sleepycat/je/rep/ReplicatedEnvironment.State.html#MASTER"><code>master</code></a> known by this node.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/NodeState.html#getNodeName--">getNodeName</a></span>()</code>
<div class="block">Returns the name of the node whose state is requested.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../com/sleepycat/je/rep/ReplicatedEnvironment.State.html" title="enum in com.sleepycat.je.rep">ReplicatedEnvironment.State</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/NodeState.html#getNodeState--">getNodeState</a></span>()</code>
<div class="block">Returns the replication <a href="../../../../com/sleepycat/je/rep/ReplicatedEnvironment.State.html" title="enum in com.sleepycat.je.rep"><code>state</code></a> of
this node.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/NodeState.html#getSystemLoad--">getSystemLoad</a></span>()</code>
<div class="block">Returns the system load average for the last minute.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/rep/NodeState.html#toString--">toString</a></span>()</code>&nbsp;</td>
</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="getNodeName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNodeName</h4>
<pre>public&nbsp;java.lang.String&nbsp;getNodeName()</pre>
<div class="block">Returns the name of the node whose state is requested.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of the node.</dd>
</dl>
</li>
</ul>
<a name="getGroupName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGroupName</h4>
<pre>public&nbsp;java.lang.String&nbsp;getGroupName()</pre>
<div class="block">Returns the name of the group which the node joins.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>name of the group which the node joins</dd>
</dl>
</li>
</ul>
<a name="getNodeState--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNodeState</h4>
<pre>public&nbsp;<a href="../../../../com/sleepycat/je/rep/ReplicatedEnvironment.State.html" title="enum in com.sleepycat.je.rep">ReplicatedEnvironment.State</a>&nbsp;getNodeState()</pre>
<div class="block">Returns the replication <a href="../../../../com/sleepycat/je/rep/ReplicatedEnvironment.State.html" title="enum in com.sleepycat.je.rep"><code>state</code></a> of
this node.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the replication state of this node.</dd>
</dl>
</li>
</ul>
<a name="getMasterName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMasterName</h4>
<pre>public&nbsp;java.lang.String&nbsp;getMasterName()</pre>
<div class="block">Returns the name of the current
<a href="../../../../com/sleepycat/je/rep/ReplicatedEnvironment.State.html#MASTER"><code>master</code></a> known by this node.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of the current master</dd>
</dl>
</li>
</ul>
<a name="getJEVersion--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJEVersion</h4>
<pre>public&nbsp;<a href="../../../../com/sleepycat/je/JEVersion.html" title="class in com.sleepycat.je">JEVersion</a>&nbsp;getJEVersion()</pre>
<div class="block">Returns the current JEVersion that this node runs on.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current JEVersion used by this node.</dd>
</dl>
</li>
</ul>
<a name="getJoinTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJoinTime</h4>
<pre>public&nbsp;long&nbsp;getJoinTime()</pre>
<div class="block">Returns the time when this node joins the replication group.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the time when this node joins the group</dd>
</dl>
</li>
</ul>
<a name="getCurrentTxnEndVLSN--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentTxnEndVLSN</h4>
<pre>public&nbsp;long&nbsp;getCurrentTxnEndVLSN()</pre>
<div class="block">Returns the latest transaction end VLSN on this replication node.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the commit VLSN on this node</dd>
</dl>
</li>
</ul>
<a name="getKnownMasterTxnEndVLSN--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKnownMasterTxnEndVLSN</h4>
<pre>public&nbsp;long&nbsp;getKnownMasterTxnEndVLSN()</pre>
<div class="block">Returns the transaction end VLSN on the master known by this node.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the known commit VLSN on master</dd>
</dl>
</li>
</ul>
<a name="getActiveFeeders--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getActiveFeeders</h4>
<pre>public&nbsp;int&nbsp;getActiveFeeders()</pre>
<div class="block">Returns the number of current active Feeders running on this node.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of running Feeders on the node</dd>
</dl>
</li>
</ul>
<a name="getLogVersion--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLogVersion</h4>
<pre>public&nbsp;int&nbsp;getLogVersion()</pre>
<div class="block">Returns the log version of this node.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the log version of this node.</dd>
</dl>
</li>
</ul>
<a name="getAppState--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAppState</h4>
<pre>public&nbsp;byte[]&nbsp;getAppState()</pre>
<div class="block">Returns the application state which is obtained via
<a href="../../../../com/sleepycat/je/rep/AppStateMonitor.html#getAppState--"><code>AppStateMonitor.getAppState()</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the application state</dd>
</dl>
</li>
</ul>
<a name="getSystemLoad--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSystemLoad</h4>
<pre>public&nbsp;double&nbsp;getSystemLoad()</pre>
<div class="block">Returns the system load average for the last minute.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the system average load, -1.0 if the node is running on jdk5 or
exceptions thrown while getting this information.</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>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="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/NodeState.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 Java Edition</b><br><font size=\"-1\"> version 7.5.11</font>
</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/sleepycat/je/rep/NoConsistencyRequiredPolicy.html" title="class in com.sleepycat.je.rep"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/sleepycat/je/rep/NodeType.html" title="enum in com.sleepycat.je.rep"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/sleepycat/je/rep/NodeState.html" target="_top">Frames</a></li>
<li><a href="NodeState.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.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>
</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) 2002, 2017 Oracle and/or its affiliates. All rights reserved.</font> </small></p>
</body>
</html>