diff options
Diffstat (limited to '_released_docs/r3.8.1/apidocs/zookeeper-server/org/apache/zookeeper/server/quorum/Learner.html')
-rw-r--r-- | _released_docs/r3.8.1/apidocs/zookeeper-server/org/apache/zookeeper/server/quorum/Learner.html | 745 |
1 files changed, 745 insertions, 0 deletions
diff --git a/_released_docs/r3.8.1/apidocs/zookeeper-server/org/apache/zookeeper/server/quorum/Learner.html b/_released_docs/r3.8.1/apidocs/zookeeper-server/org/apache/zookeeper/server/quorum/Learner.html new file mode 100644 index 000000000..c67f3c9f3 --- /dev/null +++ b/_released_docs/r3.8.1/apidocs/zookeeper-server/org/apache/zookeeper/server/quorum/Learner.html @@ -0,0 +1,745 @@ +<!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_352) on Wed Jan 25 17:31:44 CET 2023 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Learner (Apache ZooKeeper - Server 3.8.1 API)</title> +<meta name="date" content="2023-01-25"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.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="Learner (Apache ZooKeeper - Server 3.8.1 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":9,"i11":10,"i12":10,"i13":10,"i14":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/Learner.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> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/zookeeper/server/quorum/LeaderZooKeeperServer.html" title="class in org.apache.zookeeper.server.quorum"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/zookeeper/server/quorum/LearnerHandler.html" title="class in org.apache.zookeeper.server.quorum"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/zookeeper/server/quorum/Learner.html" target="_top">Frames</a></li> +<li><a href="Learner.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </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">org.apache.zookeeper.server.quorum</div> +<h2 title="Class Learner" class="title">Class Learner</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.zookeeper.server.quorum.Learner</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../org/apache/zookeeper/server/quorum/Follower.html" title="class in org.apache.zookeeper.server.quorum">Follower</a>, <a href="../../../../../org/apache/zookeeper/server/quorum/Observer.html" title="class in org.apache.zookeeper.server.quorum">Observer</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">Learner</span> +extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> +<div class="block">This class is the superclass of two of the three main actors in a ZK + ensemble: Followers and Observers. Both Followers and Observers share + a good deal of code which is moved into Peer to avoid duplication.</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" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/io/BufferedOutputStream.html?is-external=true" title="class or interface in java.io">BufferedOutputStream</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/Learner.html#bufferedOutput">bufferedOutput</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/Learner.html#closeSocketAsync">closeSocketAsync</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../../org/apache/zookeeper/server/quorum/MultipleAddresses.html" title="class in org.apache.zookeeper.server.quorum">MultipleAddresses</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/Learner.html#leaderAddr">leaderAddr</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="http://zookeeper.apache.org/zookeeper-jute/apidocs/org/apache/jute/InputArchive.html?is-external=true" title="class or interface in org.apache.jute">InputArchive</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/Learner.html#leaderIs">leaderIs</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="http://zookeeper.apache.org/zookeeper-jute/apidocs/org/apache/jute/OutputArchive.html?is-external=true" title="class or interface in org.apache.jute">OutputArchive</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/Learner.html#leaderOs">leaderOs</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/Learner.html#leaderProtocolVersion">leaderProtocolVersion</a></span></code> +<div class="block">the protocol version of the leader</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/Learner.html#LEARNER_ASYNC_SENDING">LEARNER_ASYNC_SENDING</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/Learner.html#LEARNER_CLOSE_SOCKET_ASYNC">LEARNER_CLOSE_SOCKET_ASYNC</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected static org.slf4j.Logger</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/Learner.html#LOG">LOG</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../../org/apache/zookeeper/server/util/MessageTracker.html" title="class in org.apache.zookeeper.server.util">MessageTracker</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/Learner.html#messageTracker">messageTracker</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/net/Socket.html?is-external=true" title="class or interface in java.net">Socket</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/Learner.html#sock">sock</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/atomic/AtomicBoolean.html?is-external=true" title="class or interface in java.util.concurrent.atomic">AtomicBoolean</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/Learner.html#sockBeingClosed">sockBeingClosed</a></span></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/Learner.html#Learner--">Learner</a></span>()</code> </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" 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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>protected void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/Learner.html#connectToLeader-org.apache.zookeeper.server.quorum.MultipleAddresses-java.lang.String-">connectToLeader</a></span>(<a href="../../../../../org/apache/zookeeper/server/quorum/MultipleAddresses.html" title="class in org.apache.zookeeper.server.quorum">MultipleAddresses</a> multiAddr, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> hostname)</code> +<div class="block">Establish a connection with the LearnerMaster found by findLearnerMaster.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/net/Socket.html?is-external=true" title="class or interface in java.net">Socket</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/Learner.html#createSocket--">createSocket</a></span>()</code> +<div class="block">Creating a simple or and SSL socket.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeer.QuorumServer.html" title="class in org.apache.zookeeper.server.quorum">QuorumPeer.QuorumServer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/Learner.html#findLeader--">findLeader</a></span>()</code> +<div class="block">Returns the address of the node we think is the leader.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>protected static boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/Learner.html#getAsyncSending--">getAsyncSending</a></span>()</code> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/Learner.html#getPendingRevalidationsCount--">getPendingRevalidationsCount</a></span>()</code> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/Socket.html?is-external=true" title="class or interface in java.net">Socket</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/Learner.html#getSocket--">getSocket</a></span>()</code> +<div class="block">Socket getter</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>protected long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/Learner.html#nanoTime--">nanoTime</a></span>()</code> +<div class="block">Overridable helper method to return the System.nanoTime().</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/Learner.html#ping-org.apache.zookeeper.server.quorum.QuorumPacket-">ping</a></span>(<a href="http://zookeeper.apache.org/zookeeper-jute/apidocs/org/apache/zookeeper/server/quorum/QuorumPacket.html?is-external=true" title="class or interface in org.apache.zookeeper.server.quorum">QuorumPacket</a> qp)</code> </td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>protected long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/Learner.html#registerWithLeader-int-">registerWithLeader</a></span>(int pktType)</code> +<div class="block">Once connected to the leader or learner master, perform the handshake + protocol to establish a following / observing connection.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/Learner.html#revalidate-org.apache.zookeeper.server.quorum.QuorumPacket-">revalidate</a></span>(<a href="http://zookeeper.apache.org/zookeeper-jute/apidocs/org/apache/zookeeper/server/quorum/QuorumPacket.html?is-external=true" title="class or interface in org.apache.zookeeper.server.quorum">QuorumPacket</a> qp)</code> </td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>protected static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/Learner.html#setAsyncSending-boolean-">setAsyncSending</a></span>(boolean newMode)</code> </td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/Learner.html#shutdown--">shutdown</a></span>()</code> +<div class="block">Shutdown the Peer</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/Learner.html#sockConnect-java.net.Socket-java.net.InetSocketAddress-int-">sockConnect</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/Socket.html?is-external=true" title="class or interface in java.net">Socket</a> sock, + <a href="https://docs.oracle.com/javase/8/docs/api/java/net/InetSocketAddress.html?is-external=true" title="class or interface in java.net">InetSocketAddress</a> addr, + int timeout)</code> +<div class="block">Overridable helper method to simply call sock.connect().</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/Learner.html#startSendingThread--">startSendingThread</a></span>()</code> +<div class="block">Start thread that will forward any packet in the queue to the leader</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/Learner.html#syncWithLeader-long-">syncWithLeader</a></span>(long newLeaderZxid)</code> +<div class="block">Finally, synchronize our history with the Leader (if Follower) + or the LearnerMaster (if Observer).</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></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="bufferedOutput"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>bufferedOutput</h4> +<pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/io/BufferedOutputStream.html?is-external=true" title="class or interface in java.io">BufferedOutputStream</a> bufferedOutput</pre> +</li> +</ul> +<a name="sock"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sock</h4> +<pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/net/Socket.html?is-external=true" title="class or interface in java.net">Socket</a> sock</pre> +</li> +</ul> +<a name="leaderAddr"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>leaderAddr</h4> +<pre>protected <a href="../../../../../org/apache/zookeeper/server/quorum/MultipleAddresses.html" title="class in org.apache.zookeeper.server.quorum">MultipleAddresses</a> leaderAddr</pre> +</li> +</ul> +<a name="sockBeingClosed"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sockBeingClosed</h4> +<pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/atomic/AtomicBoolean.html?is-external=true" title="class or interface in java.util.concurrent.atomic">AtomicBoolean</a> sockBeingClosed</pre> +</li> +</ul> +<a name="leaderIs"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>leaderIs</h4> +<pre>protected <a href="http://zookeeper.apache.org/zookeeper-jute/apidocs/org/apache/jute/InputArchive.html?is-external=true" title="class or interface in org.apache.jute">InputArchive</a> leaderIs</pre> +</li> +</ul> +<a name="leaderOs"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>leaderOs</h4> +<pre>protected <a href="http://zookeeper.apache.org/zookeeper-jute/apidocs/org/apache/jute/OutputArchive.html?is-external=true" title="class or interface in org.apache.jute">OutputArchive</a> leaderOs</pre> +</li> +</ul> +<a name="leaderProtocolVersion"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>leaderProtocolVersion</h4> +<pre>protected int leaderProtocolVersion</pre> +<div class="block">the protocol version of the leader</div> +</li> +</ul> +<a name="messageTracker"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>messageTracker</h4> +<pre>protected final <a href="../../../../../org/apache/zookeeper/server/util/MessageTracker.html" title="class in org.apache.zookeeper.server.util">MessageTracker</a> messageTracker</pre> +</li> +</ul> +<a name="LOG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LOG</h4> +<pre>protected static final org.slf4j.Logger LOG</pre> +</li> +</ul> +<a name="LEARNER_ASYNC_SENDING"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LEARNER_ASYNC_SENDING</h4> +<pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> LEARNER_ASYNC_SENDING</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.zookeeper.server.quorum.Learner.LEARNER_ASYNC_SENDING">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="LEARNER_CLOSE_SOCKET_ASYNC"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LEARNER_CLOSE_SOCKET_ASYNC</h4> +<pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> LEARNER_CLOSE_SOCKET_ASYNC</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.zookeeper.server.quorum.Learner.LEARNER_CLOSE_SOCKET_ASYNC">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="closeSocketAsync"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>closeSocketAsync</h4> +<pre>public static final boolean closeSocketAsync</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="Learner--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Learner</h4> +<pre>public Learner()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getSocket--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSocket</h4> +<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/net/Socket.html?is-external=true" title="class or interface in java.net">Socket</a> getSocket()</pre> +<div class="block">Socket getter</div> +</li> +</ul> +<a name="getPendingRevalidationsCount--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPendingRevalidationsCount</h4> +<pre>public int getPendingRevalidationsCount()</pre> +</li> +</ul> +<a name="setAsyncSending-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAsyncSending</h4> +<pre>protected static void setAsyncSending(boolean newMode)</pre> +</li> +</ul> +<a name="getAsyncSending--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAsyncSending</h4> +<pre>protected static boolean getAsyncSending()</pre> +</li> +</ul> +<a name="startSendingThread--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>startSendingThread</h4> +<pre>protected void startSendingThread()</pre> +<div class="block">Start thread that will forward any packet in the queue to the leader</div> +</li> +</ul> +<a name="findLeader--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>findLeader</h4> +<pre>protected <a href="../../../../../org/apache/zookeeper/server/quorum/QuorumPeer.QuorumServer.html" title="class in org.apache.zookeeper.server.quorum">QuorumPeer.QuorumServer</a> findLeader()</pre> +<div class="block">Returns the address of the node we think is the leader.</div> +</li> +</ul> +<a name="nanoTime--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>nanoTime</h4> +<pre>protected long nanoTime()</pre> +<div class="block">Overridable helper method to return the System.nanoTime(). + This method behaves identical to System.nanoTime().</div> +</li> +</ul> +<a name="sockConnect-java.net.Socket-java.net.InetSocketAddress-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sockConnect</h4> +<pre>protected void sockConnect(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/Socket.html?is-external=true" title="class or interface in java.net">Socket</a> sock, + <a href="https://docs.oracle.com/javase/8/docs/api/java/net/InetSocketAddress.html?is-external=true" title="class or interface in java.net">InetSocketAddress</a> addr, + int timeout) + throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block">Overridable helper method to simply call sock.connect(). This can be + overriden in tests to fake connection success/failure for connectToLeader.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> +</dl> +</li> +</ul> +<a name="connectToLeader-org.apache.zookeeper.server.quorum.MultipleAddresses-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>connectToLeader</h4> +<pre>protected void connectToLeader(<a href="../../../../../org/apache/zookeeper/server/quorum/MultipleAddresses.html" title="class in org.apache.zookeeper.server.quorum">MultipleAddresses</a> multiAddr, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> hostname) + throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block">Establish a connection with the LearnerMaster found by findLearnerMaster. + Followers only connect to Leaders, Observers can connect to any active LearnerMaster. + Retries until either initLimit time has elapsed or 5 tries have happened.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>multiAddr</code> - - the address of the Peer to connect to.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - - if the socket connection fails on the 5th attempt + if there is an authentication failure while connecting to leader</dd> +</dl> +</li> +</ul> +<a name="createSocket--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createSocket</h4> +<pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/net/Socket.html?is-external=true" title="class or interface in java.net">Socket</a> createSocket() + throws <a href="../../../../../org/apache/zookeeper/common/X509Exception.html" title="class in org.apache.zookeeper.common">X509Exception</a>, + <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block">Creating a simple or and SSL socket. + This can be overridden in tests to fake already connected sockets for connectToLeader.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/zookeeper/common/X509Exception.html" title="class in org.apache.zookeeper.common">X509Exception</a></code></dd> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> +</dl> +</li> +</ul> +<a name="registerWithLeader-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>registerWithLeader</h4> +<pre>protected long registerWithLeader(int pktType) + throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block">Once connected to the leader or learner master, perform the handshake + protocol to establish a following / observing connection.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>pktType</code> - </dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the zxid the Leader sends for synchronization purposes.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> +</dl> +</li> +</ul> +<a name="syncWithLeader-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>syncWithLeader</h4> +<pre>protected void syncWithLeader(long newLeaderZxid) + throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> +<div class="block">Finally, synchronize our history with the Leader (if Follower) + or the LearnerMaster (if Observer).</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>newLeaderZxid</code> - </dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code></dd> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd> +</dl> +</li> +</ul> +<a name="revalidate-org.apache.zookeeper.server.quorum.QuorumPacket-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>revalidate</h4> +<pre>protected void revalidate(<a href="http://zookeeper.apache.org/zookeeper-jute/apidocs/org/apache/zookeeper/server/quorum/QuorumPacket.html?is-external=true" title="class or interface in org.apache.zookeeper.server.quorum">QuorumPacket</a> qp) + throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> +</dl> +</li> +</ul> +<a name="ping-org.apache.zookeeper.server.quorum.QuorumPacket-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ping</h4> +<pre>protected void ping(<a href="http://zookeeper.apache.org/zookeeper-jute/apidocs/org/apache/zookeeper/server/quorum/QuorumPacket.html?is-external=true" title="class or interface in org.apache.zookeeper.server.quorum">QuorumPacket</a> qp) + throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> +</dl> +</li> +</ul> +<a name="shutdown--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>shutdown</h4> +<pre>public void shutdown()</pre> +<div class="block">Shutdown the Peer</div> +</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/Learner.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> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/zookeeper/server/quorum/LeaderZooKeeperServer.html" title="class in org.apache.zookeeper.server.quorum"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/zookeeper/server/quorum/LearnerHandler.html" title="class in org.apache.zookeeper.server.quorum"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/zookeeper/server/quorum/Learner.html" target="_top">Frames</a></li> +<li><a href="Learner.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </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>Copyright © 2008–2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> |