solr-4.5.1/docs/solr-core/org/apache/solr/update/PeerSync.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <!-- NewPage -->
   3 <html lang="en">
   4 <head>
   5 <!-- Generated by javadoc (version 1.6.0_27) on Thu Oct 17 21:44:58 EDT 2013 -->
   6 <meta http-equiv="Content-Type" content="text/html" charset="utf-8">
   7 <title>PeerSync (Solr 4.5.1 API)</title>
   8 <meta name="date" content="2013-10-17">
   9 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
  10 </head>
  11 <body>
  12 <script type="text/javascript"><!--
  13     if (location.href.indexOf('is-external=true') == -1) {
  14         parent.document.title="PeerSync (Solr 4.5.1 API)";
  15     }
  16 //-->
  17 </script>
  18 <noscript>
  19 <div>JavaScript is disabled on your browser.</div>
  20 </noscript>
  21 <!-- ========= START OF TOP NAVBAR ======= -->
  22 <div class="topNav"><a name="navbar_top">
  23 <!--   -->
  24 </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
  25 <!--   -->
  26 </a>
  27 <ul class="navList" title="Navigation">
  28 <li><a href="../../../../overview-summary.html">Overview</a></li>
  29 <li><a href="package-summary.html">Package</a></li>
  30 <li class="navBarCell1Rev">Class</li>
  31 <li><a href="class-use/PeerSync.html">Use</a></li>
  32 <li><a href="package-tree.html">Tree</a></li>
  33 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  34 <li><a href="../../../../help-doc.html">Help</a></li>
  35 </ul>
  36 </div>
  37 <div class="subNav">
  38 <ul class="navList">
  39 <li><a href="../../../../org/apache/solr/update/MergeIndexesCommand.html" title="class in org.apache.solr.update"><span class="strong">PREV CLASS</span></a></li>
  40 <li><a href="../../../../org/apache/solr/update/RollbackUpdateCommand.html" title="class in org.apache.solr.update"><span class="strong">NEXT CLASS</span></a></li>
  41 </ul>
  42 <ul class="navList">
  43 <li><a href="../../../../index.html?org/apache/solr/update/PeerSync.html" target="_top">FRAMES</a></li>
  44 <li><a href="PeerSync.html" target="_top">NO FRAMES</a></li>
  45 </ul>
  46 <ul class="navList" id="allclasses_navbar_top">
  47 <li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
  48 </ul>
  49 <div>
  50 <script type="text/javascript"><!--
  51   allClassesLink = document.getElementById("allclasses_navbar_top");
  52   if(window==top) {
  53     allClassesLink.style.display = "block";
  54   }
  55   else {
  56     allClassesLink.style.display = "none";
  57   }
  58   //-->
  59 </script>
  60 </div>
  61 <div>
  62 <ul class="subNavList">
  63 <li>SUMMARY:&nbsp;</li>
  64 <li>NESTED&nbsp;|&nbsp;</li>
  65 <li><a href="#field_summary">FIELD</a>&nbsp;|&nbsp;</li>
  66 <li><a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;</li>
  67 <li><a href="#method_summary">METHOD</a></li>
  68 </ul>
  69 <ul class="subNavList">
  70 <li>DETAIL:&nbsp;</li>
  71 <li><a href="#field_detail">FIELD</a>&nbsp;|&nbsp;</li>
  72 <li><a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;</li>
  73 <li><a href="#method_detail">METHOD</a></li>
  74 </ul>
  75 </div>
  76 <a name="skip-navbar_top">
  77 <!--   -->
  78 </a></div>
  79 <!-- ========= END OF TOP NAVBAR ========= -->
  80 <!-- ======== START OF CLASS DATA ======== -->
  81 <div class="header">
  82 <p class="subTitle">org.apache.solr.update</p>
  83 <h2 title="Class PeerSync" class="title">Class PeerSync</h2>
  84 </div>
  85 <div class="contentContainer">
  86 <ul class="inheritance">
  87 <li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
  88 <li>
  89 <ul class="inheritance">
  90 <li>org.apache.solr.update.PeerSync</li>
  91 </ul>
  92 </li>
  93 </ul>
  94 <div class="description">
  95 <ul class="blockList">
  96 <li class="blockList">
  97 <hr>
  98 <br>
  99 <pre>public class <strong>PeerSync</strong>
 100 extends <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
 101 <dl><dt><span class="strong">WARNING: This API is experimental and might change in incompatible ways in the next release.</span></dt>
 102   <dd></dd></dl>
 103 </li>
 104 </ul>
 105 </div>
 106 <div class="summary">
 107 <ul class="blockList">
 108 <li class="blockList">
 109 <!-- =========== FIELD SUMMARY =========== -->
 110 <ul class="blockList">
 111 <li class="blockList"><a name="field_summary">
 112 <!--   -->
 113 </a>
 114 <h3>Field Summary</h3>
 115 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
 116 <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
 117 <tr>
 118 <th class="colFirst" scope="col">Modifier and Type</th>
 119 <th class="colLast" scope="col">Field and Description</th>
 120 </tr>
 121 <tr class="altColor">
 122 <td class="colFirst"><code>boolean</code></td>
 123 <td class="colLast"><code><strong><a href="../../../../org/apache/solr/update/PeerSync.html#debug">debug</a></strong></code>&nbsp;</td>
 124 </tr>
 125 <tr class="rowColor">
 126 <td class="colFirst"><code>static org.slf4j.Logger</code></td>
 127 <td class="colLast"><code><strong><a href="../../../../org/apache/solr/update/PeerSync.html#log">log</a></strong></code>&nbsp;</td>
 128 </tr>
 129 </table>
 130 </li>
 131 </ul>
 132 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 133 <ul class="blockList">
 134 <li class="blockList"><a name="constructor_summary">
 135 <!--   -->
 136 </a>
 137 <h3>Constructor Summary</h3>
 138 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
 139 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
 140 <tr>
 141 <th class="colOne" scope="col">Constructor and Description</th>
 142 </tr>
 143 <tr class="altColor">
 144 <td class="colOne"><code><strong><a href="../../../../org/apache/solr/update/PeerSync.html#PeerSync(org.apache.solr.core.SolrCore, java.util.List, int)">PeerSync</a></strong>(<a href="../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</a>&nbsp;core,
 145         <a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;replicas,
 146         int&nbsp;nUpdates)</code>&nbsp;</td>
 147 </tr>
 148 <tr class="rowColor">
 149 <td class="colOne"><code><strong><a href="../../../../org/apache/solr/update/PeerSync.html#PeerSync(org.apache.solr.core.SolrCore, java.util.List, int, boolean, boolean)">PeerSync</a></strong>(<a href="../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</a>&nbsp;core,
 150         <a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;replicas,
 151         int&nbsp;nUpdates,
 152         boolean&nbsp;cantReachIsSuccess,
 153         boolean&nbsp;getNoVersionsIsSuccess)</code>&nbsp;</td>
 154 </tr>
 155 </table>
 156 </li>
 157 </ul>
 158 <!-- ========== METHOD SUMMARY =========== -->
 159 <ul class="blockList">
 160 <li class="blockList"><a name="method_summary">
 161 <!--   -->
 162 </a>
 163 <h3>Method Summary</h3>
 164 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 165 <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
 166 <tr>
 167 <th class="colFirst" scope="col">Modifier and Type</th>
 168 <th class="colLast" scope="col">Method and Description</th>
 169 </tr>
 170 <tr class="altColor">
 171 <td class="colFirst"><code>long</code></td>
 172 <td class="colLast"><code><strong><a href="../../../../org/apache/solr/update/PeerSync.html#percentile(java.util.List, float)">percentile</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&gt;&nbsp;arr,
 173           float&nbsp;frac)</code>&nbsp;</td>
 174 </tr>
 175 <tr class="rowColor">
 176 <td class="colFirst"><code>void</code></td>
 177 <td class="colLast"><code><strong><a href="../../../../org/apache/solr/update/PeerSync.html#setStartingVersions(java.util.List)">setStartingVersions</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&gt;&nbsp;startingVersions)</code>
 178 <div class="block">optional list of updates we had before possibly receiving new updates</div>
 179 </td>
 180 </tr>
 181 <tr class="altColor">
 182 <td class="colFirst"><code>boolean</code></td>
 183 <td class="colLast"><code><strong><a href="../../../../org/apache/solr/update/PeerSync.html#sync()">sync</a></strong>()</code>
 184 <div class="block">Returns true if peer sync was successful, meaning that this core may not be considered to have the latest updates
 185   when considering the last N updates between it and it's peers.</div>
 186 </td>
 187 </tr>
 188 <tr class="rowColor">
 189 <td class="colFirst"><code>static void</code></td>
 190 <td class="colLast"><code><strong><a href="../../../../org/apache/solr/update/PeerSync.html#sync(org.apache.solr.core.SolrCore, java.util.List, int)">sync</a></strong>(<a href="../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</a>&nbsp;core,
 191     <a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;replicas,
 192     int&nbsp;nUpdates)</code>
 193 <div class="block">Requests and applies recent updates from peers</div>
 194 </td>
 195 </tr>
 196 </table>
 197 <ul class="blockList">
 198 <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
 199 <!--   -->
 200 </a>
 201 <h3>Methods inherited from class&nbsp;java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
 202 <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
 203 </ul>
 204 </li>
 205 </ul>
 206 </li>
 207 </ul>
 208 </div>
 209 <div class="details">
 210 <ul class="blockList">
 211 <li class="blockList">
 212 <!-- ============ FIELD DETAIL =========== -->
 213 <ul class="blockList">
 214 <li class="blockList"><a name="field_detail">
 215 <!--   -->
 216 </a>
 217 <h3>Field Detail</h3>
 218 <a name="log">
 219 <!--   -->
 220 </a>
 221 <ul class="blockList">
 222 <li class="blockList">
 223 <h4>log</h4>
 224 <pre>public static&nbsp;org.slf4j.Logger log</pre>
 225 </li>
 226 </ul>
 227 <a name="debug">
 228 <!--   -->
 229 </a>
 230 <ul class="blockListLast">
 231 <li class="blockList">
 232 <h4>debug</h4>
 233 <pre>public&nbsp;boolean debug</pre>
 234 </li>
 235 </ul>
 236 </li>
 237 </ul>
 238 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 239 <ul class="blockList">
 240 <li class="blockList"><a name="constructor_detail">
 241 <!--   -->
 242 </a>
 243 <h3>Constructor Detail</h3>
 244 <a name="PeerSync(org.apache.solr.core.SolrCore, java.util.List, int)">
 245 <!--   -->
 246 </a>
 247 <ul class="blockList">
 248 <li class="blockList">
 249 <h4>PeerSync</h4>
 250 <pre>public&nbsp;PeerSync(<a href="../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</a>&nbsp;core,
 251         <a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;replicas,
 252         int&nbsp;nUpdates)</pre>
 253 </li>
 254 </ul>
 255 <a name="PeerSync(org.apache.solr.core.SolrCore, java.util.List, int, boolean, boolean)">
 256 <!--   -->
 257 </a>
 258 <ul class="blockListLast">
 259 <li class="blockList">
 260 <h4>PeerSync</h4>
 261 <pre>public&nbsp;PeerSync(<a href="../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</a>&nbsp;core,
 262         <a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;replicas,
 263         int&nbsp;nUpdates,
 264         boolean&nbsp;cantReachIsSuccess,
 265         boolean&nbsp;getNoVersionsIsSuccess)</pre>
 266 </li>
 267 </ul>
 268 </li>
 269 </ul>
 270 <!-- ============ METHOD DETAIL ========== -->
 271 <ul class="blockList">
 272 <li class="blockList"><a name="method_detail">
 273 <!--   -->
 274 </a>
 275 <h3>Method Detail</h3>
 276 <a name="setStartingVersions(java.util.List)">
 277 <!--   -->
 278 </a>
 279 <ul class="blockList">
 280 <li class="blockList">
 281 <h4>setStartingVersions</h4>
 282 <pre>public&nbsp;void&nbsp;setStartingVersions(<a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&gt;&nbsp;startingVersions)</pre>
 283 <div class="block">optional list of updates we had before possibly receiving new updates</div>
 284 </li>
 285 </ul>
 286 <a name="percentile(java.util.List, float)">
 287 <!--   -->
 288 </a>
 289 <ul class="blockList">
 290 <li class="blockList">
 291 <h4>percentile</h4>
 292 <pre>public&nbsp;long&nbsp;percentile(<a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&gt;&nbsp;arr,
 293               float&nbsp;frac)</pre>
 294 </li>
 295 </ul>
 296 <a name="sync()">
 297 <!--   -->
 298 </a>
 299 <ul class="blockList">
 300 <li class="blockList">
 301 <h4>sync</h4>
 302 <pre>public&nbsp;boolean&nbsp;sync()</pre>
 303 <div class="block">Returns true if peer sync was successful, meaning that this core may not be considered to have the latest updates
 304   when considering the last N updates between it and it's peers.
 305   A commit is not performed.</div>
 306 </li>
 307 </ul>
 308 <a name="sync(org.apache.solr.core.SolrCore, java.util.List, int)">
 309 <!--   -->
 310 </a>
 311 <ul class="blockListLast">
 312 <li class="blockList">
 313 <h4>sync</h4>
 314 <pre>public static&nbsp;void&nbsp;sync(<a href="../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</a>&nbsp;core,
 315         <a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;replicas,
 316         int&nbsp;nUpdates)</pre>
 317 <div class="block">Requests and applies recent updates from peers</div>
 318 </li>
 319 </ul>
 320 </li>
 321 </ul>
 322 </li>
 323 </ul>
 324 </div>
 325 </div>
 326 <!-- ========= END OF CLASS DATA ========= -->
 327 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 328 <div class="bottomNav"><a name="navbar_bottom">
 329 <!--   -->
 330 </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
 331 <!--   -->
 332 </a>
 333 <ul class="navList" title="Navigation">
 334 <li><a href="../../../../overview-summary.html">Overview</a></li>
 335 <li><a href="package-summary.html">Package</a></li>
 336 <li class="navBarCell1Rev">Class</li>
 337 <li><a href="class-use/PeerSync.html">Use</a></li>
 338 <li><a href="package-tree.html">Tree</a></li>
 339 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
 340 <li><a href="../../../../help-doc.html">Help</a></li>
 341 </ul>
 342 </div>
 343 <div class="subNav">
 344 <ul class="navList">
 345 <li><a href="../../../../org/apache/solr/update/MergeIndexesCommand.html" title="class in org.apache.solr.update"><span class="strong">PREV CLASS</span></a></li>
 346 <li><a href="../../../../org/apache/solr/update/RollbackUpdateCommand.html" title="class in org.apache.solr.update"><span class="strong">NEXT CLASS</span></a></li>
 347 </ul>
 348 <ul class="navList">
 349 <li><a href="../../../../index.html?org/apache/solr/update/PeerSync.html" target="_top">FRAMES</a></li>
 350 <li><a href="PeerSync.html" target="_top">NO FRAMES</a></li>
 351 </ul>
 352 <ul class="navList" id="allclasses_navbar_bottom">
 353 <li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
 354 </ul>
 355 <div>
 356 <script type="text/javascript"><!--
 357   allClassesLink = document.getElementById("allclasses_navbar_bottom");
 358   if(window==top) {
 359     allClassesLink.style.display = "block";
 360   }
 361   else {
 362     allClassesLink.style.display = "none";
 363   }
 364   //-->
 365 </script>
 366 </div>
 367 <div>
 368 <ul class="subNavList">
 369 <li>SUMMARY:&nbsp;</li>
 370 <li>NESTED&nbsp;|&nbsp;</li>
 371 <li><a href="#field_summary">FIELD</a>&nbsp;|&nbsp;</li>
 372 <li><a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;</li>
 373 <li><a href="#method_summary">METHOD</a></li>
 374 </ul>
 375 <ul class="subNavList">
 376 <li>DETAIL:&nbsp;</li>
 377 <li><a href="#field_detail">FIELD</a>&nbsp;|&nbsp;</li>
 378 <li><a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;</li>
 379 <li><a href="#method_detail">METHOD</a></li>
 380 </ul>
 381 </div>
 382 <a name="skip-navbar_bottom">
 383 <!--   -->
 384 </a></div>
 385 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 386 <p class="legalCopy"><small>
 387           <i>Copyright &copy; 2000-2013 Apache Software Foundation.  All Rights Reserved.</i>
 388           <script src='../../../../prettify.js' type='text/javascript'></script>
 389           <script type='text/javascript'>
 390             (function(){
 391               var oldonload = window.onload;
 392               if (typeof oldonload != 'function') {
 393                 window.onload = prettyPrint;
 394               } else {
 395                 window.onload = function() {
 396                   oldonload();
 397                   prettyPrint();
 398                 }
 399               }
 400             })();
 401           </script>
 402         </small></p>
 403 </body>
 404 </html>