| <!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 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Waiter (Apache HBase 3.0.0-alpha-2-SNAPSHOT Test API)</title> |
| <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="Waiter (Apache HBase 3.0.0-alpha-2-SNAPSHOT Test API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/Waiter.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/hadoop/hbase/TimestampTestBase.FlushCache.html" title="interface in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/hadoop/hbase/Waiter.ExplainingPredicate.html" title="interface in org.apache.hadoop.hbase"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/hadoop/hbase/Waiter.html" target="_top">Frames</a></li> |
| <li><a href="Waiter.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><a href="#nested.class.summary">Nested</a> | </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.hadoop.hbase</div> |
| <h2 title="Class Waiter" class="title">Class Waiter</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.hadoop.hbase.Waiter</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>@InterfaceAudience.Private |
| public final class <a href="../../../../src-html/org/apache/hadoop/hbase/Waiter.html#line.36">Waiter</a> |
| 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">A class that provides a standard waitFor pattern |
| See details at https://issues.apache.org/jira/browse/HBASE-7384</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Waiter.ExplainingPredicate.html" title="interface in org.apache.hadoop.hbase">Waiter.ExplainingPredicate</a><<a href="../../../../org/apache/hadoop/hbase/Waiter.ExplainingPredicate.html" title="type parameter in Waiter.ExplainingPredicate">E</a> extends <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>></span></code> |
| <div class="block">A mixin interface, can be used with <a href="../../../../org/apache/hadoop/hbase/Waiter.html" title="class in org.apache.hadoop.hbase"><code>Waiter</code></a> to explain failed state.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Waiter.Predicate.html" title="interface in org.apache.hadoop.hbase">Waiter.Predicate</a><<a href="../../../../org/apache/hadoop/hbase/Waiter.Predicate.html" title="type parameter in Waiter.Predicate">E</a> extends <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>></span></code> |
| <div class="block">A predicate 'closure' used by the <a href="../../../../org/apache/hadoop/hbase/Waiter.html#waitFor-org.apache.hadoop.conf.Configuration-long-org.apache.hadoop.hbase.Waiter.Predicate-"><code>waitFor(Configuration, long, Predicate)</code></a> and |
| <a href="../../../../org/apache/hadoop/hbase/Waiter.html#waitFor-org.apache.hadoop.conf.Configuration-long-org.apache.hadoop.hbase.Waiter.Predicate-"><code>waitFor(Configuration, long, Predicate)</code></a> and |
| <a href="../../../../org/apache/hadoop/hbase/Waiter.html#waitFor-org.apache.hadoop.conf.Configuration-long-long-boolean-org.apache.hadoop.hbase.Waiter.Predicate-"><code>waitFor(Configuration, long, long, boolean, Predicate)</code></a> methods.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== 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>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/hadoop/hbase/Waiter.html#HBASE_TEST_WAIT_FOR_RATIO">HBASE_TEST_WAIT_FOR_RATIO</a></span></code> |
| <div class="block">System property name whose value is a scale factor to increase time out values dynamically used |
| in <a href="../../../../org/apache/hadoop/hbase/Waiter.html#sleep-org.apache.hadoop.conf.Configuration-long-"><code>sleep(Configuration, long)</code></a>, <a href="../../../../org/apache/hadoop/hbase/Waiter.html#waitFor-org.apache.hadoop.conf.Configuration-long-org.apache.hadoop.hbase.Waiter.Predicate-"><code>waitFor(Configuration, long, Predicate)</code></a>, |
| <a href="../../../../org/apache/hadoop/hbase/Waiter.html#waitFor-org.apache.hadoop.conf.Configuration-long-long-org.apache.hadoop.hbase.Waiter.Predicate-"><code>waitFor(Configuration, long, long, Predicate)</code></a>, and |
| <a href="../../../../org/apache/hadoop/hbase/Waiter.html#waitFor-org.apache.hadoop.conf.Configuration-long-long-boolean-org.apache.hadoop.hbase.Waiter.Predicate-"><code>waitFor(Configuration, long, long, boolean, Predicate)</code></a> method |
| <p/> |
| The actual time out value will equal to hbase.test.wait.for.ratio * passed-in timeout</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>private static float</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Waiter.html#HBASE_WAIT_FOR_RATIO_DEFAULT">HBASE_WAIT_FOR_RATIO_DEFAULT</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>private static org.slf4j.Logger</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Waiter.html#LOG">LOG</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>private static float</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Waiter.html#waitForRatio">waitForRatio</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="colFirst" scope="col">Modifier</th> |
| <th class="colLast" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>private </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Waiter.html#Waiter--">Waiter</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="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>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/hadoop/hbase/Waiter.html#getExplanation-org.apache.hadoop.hbase.Waiter.Predicate-">getExplanation</a></span>(<a href="../../../../org/apache/hadoop/hbase/Waiter.Predicate.html" title="interface in org.apache.hadoop.hbase">Waiter.Predicate</a><?> explain)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static float</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Waiter.html#getWaitForRatio-org.apache.hadoop.conf.Configuration-">getWaitForRatio</a></span>(org.apache.hadoop.conf.Configuration conf)</code> |
| <div class="block">Returns the 'wait for ratio' used in the <a href="../../../../org/apache/hadoop/hbase/Waiter.html#sleep-org.apache.hadoop.conf.Configuration-long-"><code>sleep(Configuration, long)</code></a>, |
| <a href="../../../../org/apache/hadoop/hbase/Waiter.html#waitFor-org.apache.hadoop.conf.Configuration-long-org.apache.hadoop.hbase.Waiter.Predicate-"><code>waitFor(Configuration, long, Predicate)</code></a>, |
| <a href="../../../../org/apache/hadoop/hbase/Waiter.html#waitFor-org.apache.hadoop.conf.Configuration-long-long-org.apache.hadoop.hbase.Waiter.Predicate-"><code>waitFor(Configuration, long, long, Predicate)</code></a> and |
| <a href="../../../../org/apache/hadoop/hbase/Waiter.html#waitFor-org.apache.hadoop.conf.Configuration-long-long-boolean-org.apache.hadoop.hbase.Waiter.Predicate-"><code>waitFor(Configuration, long, long, boolean, Predicate)</code></a> methods of the class |
| <p/> |
| This is useful to dynamically adjust max time out values when same test cases run in different |
| test machine settings without recompiling & re-deploying code.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Waiter.html#sleep-org.apache.hadoop.conf.Configuration-long-">sleep</a></span>(org.apache.hadoop.conf.Configuration conf, |
| long time)</code> |
| <div class="block">Makes the current thread sleep for the duration equal to the specified time in milliseconds |
| multiplied by the <a href="../../../../org/apache/hadoop/hbase/Waiter.html#getWaitForRatio-org.apache.hadoop.conf.Configuration-"><code>getWaitForRatio(Configuration)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <E extends <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>><br>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Waiter.html#waitFor-org.apache.hadoop.conf.Configuration-long-long-boolean-org.apache.hadoop.hbase.Waiter.Predicate-">waitFor</a></span>(org.apache.hadoop.conf.Configuration conf, |
| long timeout, |
| long interval, |
| boolean failIfTimeout, |
| <a href="../../../../org/apache/hadoop/hbase/Waiter.Predicate.html" title="interface in org.apache.hadoop.hbase">Waiter.Predicate</a><E> predicate)</code> |
| <div class="block">Waits up to the duration equal to the specified timeout multiplied by the |
| <a href="../../../../org/apache/hadoop/hbase/Waiter.html#getWaitForRatio-org.apache.hadoop.conf.Configuration-"><code>getWaitForRatio(Configuration)</code></a> for the given <a href="../../../../org/apache/hadoop/hbase/Waiter.Predicate.html" title="interface in org.apache.hadoop.hbase"><code>Waiter.Predicate</code></a> to become |
| <code>true</code>, failing the test if the timeout is reached, the Predicate is still |
| <code>false</code> and failIfTimeout is set as <code>true</code>.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <E extends <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>><br>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Waiter.html#waitFor-org.apache.hadoop.conf.Configuration-long-long-org.apache.hadoop.hbase.Waiter.Predicate-">waitFor</a></span>(org.apache.hadoop.conf.Configuration conf, |
| long timeout, |
| long interval, |
| <a href="../../../../org/apache/hadoop/hbase/Waiter.Predicate.html" title="interface in org.apache.hadoop.hbase">Waiter.Predicate</a><E> predicate)</code> |
| <div class="block">Waits up to the duration equal to the specified timeout multiplied by the |
| <a href="../../../../org/apache/hadoop/hbase/Waiter.html#getWaitForRatio-org.apache.hadoop.conf.Configuration-"><code>getWaitForRatio(Configuration)</code></a> for the given <a href="../../../../org/apache/hadoop/hbase/Waiter.Predicate.html" title="interface in org.apache.hadoop.hbase"><code>Waiter.Predicate</code></a> to become |
| <code>true</code>, failing the test if the timeout is reached and the Predicate is still |
| <code>false</code>.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static <E extends <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>><br>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Waiter.html#waitFor-org.apache.hadoop.conf.Configuration-long-org.apache.hadoop.hbase.Waiter.Predicate-">waitFor</a></span>(org.apache.hadoop.conf.Configuration conf, |
| long timeout, |
| <a href="../../../../org/apache/hadoop/hbase/Waiter.Predicate.html" title="interface in org.apache.hadoop.hbase">Waiter.Predicate</a><E> predicate)</code> |
| <div class="block">Waits up to the duration equal to the specified timeout multiplied by the |
| <a href="../../../../org/apache/hadoop/hbase/Waiter.html#getWaitForRatio-org.apache.hadoop.conf.Configuration-"><code>getWaitForRatio(Configuration)</code></a> for the given <a href="../../../../org/apache/hadoop/hbase/Waiter.Predicate.html" title="interface in org.apache.hadoop.hbase"><code>Waiter.Predicate</code></a> to become |
| <code>true</code>, failing the test if the timeout is reached and the Predicate is still |
| <code>false</code>.</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="LOG"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>LOG</h4> |
| <pre>private static final org.slf4j.Logger <a href="../../../../src-html/org/apache/hadoop/hbase/Waiter.html#line.37">LOG</a></pre> |
| </li> |
| </ul> |
| <a name="HBASE_TEST_WAIT_FOR_RATIO"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HBASE_TEST_WAIT_FOR_RATIO</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> <a href="../../../../src-html/org/apache/hadoop/hbase/Waiter.html#line.47">HBASE_TEST_WAIT_FOR_RATIO</a></pre> |
| <div class="block">System property name whose value is a scale factor to increase time out values dynamically used |
| in <a href="../../../../org/apache/hadoop/hbase/Waiter.html#sleep-org.apache.hadoop.conf.Configuration-long-"><code>sleep(Configuration, long)</code></a>, <a href="../../../../org/apache/hadoop/hbase/Waiter.html#waitFor-org.apache.hadoop.conf.Configuration-long-org.apache.hadoop.hbase.Waiter.Predicate-"><code>waitFor(Configuration, long, Predicate)</code></a>, |
| <a href="../../../../org/apache/hadoop/hbase/Waiter.html#waitFor-org.apache.hadoop.conf.Configuration-long-long-org.apache.hadoop.hbase.Waiter.Predicate-"><code>waitFor(Configuration, long, long, Predicate)</code></a>, and |
| <a href="../../../../org/apache/hadoop/hbase/Waiter.html#waitFor-org.apache.hadoop.conf.Configuration-long-long-boolean-org.apache.hadoop.hbase.Waiter.Predicate-"><code>waitFor(Configuration, long, long, boolean, Predicate)</code></a> method |
| <p/> |
| The actual time out value will equal to hbase.test.wait.for.ratio * passed-in timeout</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.Waiter.HBASE_TEST_WAIT_FOR_RATIO">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="HBASE_WAIT_FOR_RATIO_DEFAULT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HBASE_WAIT_FOR_RATIO_DEFAULT</h4> |
| <pre>private static float <a href="../../../../src-html/org/apache/hadoop/hbase/Waiter.html#line.49">HBASE_WAIT_FOR_RATIO_DEFAULT</a></pre> |
| </li> |
| </ul> |
| <a name="waitForRatio"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>waitForRatio</h4> |
| <pre>private static float <a href="../../../../src-html/org/apache/hadoop/hbase/Waiter.html#line.51">waitForRatio</a></pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="Waiter--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Waiter</h4> |
| <pre>private <a href="../../../../src-html/org/apache/hadoop/hbase/Waiter.html#line.53">Waiter</a>()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getWaitForRatio-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWaitForRatio</h4> |
| <pre>public static float <a href="../../../../src-html/org/apache/hadoop/hbase/Waiter.html#line.70">getWaitForRatio</a>(org.apache.hadoop.conf.Configuration conf)</pre> |
| <div class="block">Returns the 'wait for ratio' used in the <a href="../../../../org/apache/hadoop/hbase/Waiter.html#sleep-org.apache.hadoop.conf.Configuration-long-"><code>sleep(Configuration, long)</code></a>, |
| <a href="../../../../org/apache/hadoop/hbase/Waiter.html#waitFor-org.apache.hadoop.conf.Configuration-long-org.apache.hadoop.hbase.Waiter.Predicate-"><code>waitFor(Configuration, long, Predicate)</code></a>, |
| <a href="../../../../org/apache/hadoop/hbase/Waiter.html#waitFor-org.apache.hadoop.conf.Configuration-long-long-org.apache.hadoop.hbase.Waiter.Predicate-"><code>waitFor(Configuration, long, long, Predicate)</code></a> and |
| <a href="../../../../org/apache/hadoop/hbase/Waiter.html#waitFor-org.apache.hadoop.conf.Configuration-long-long-boolean-org.apache.hadoop.hbase.Waiter.Predicate-"><code>waitFor(Configuration, long, long, boolean, Predicate)</code></a> methods of the class |
| <p/> |
| This is useful to dynamically adjust max time out values when same test cases run in different |
| test machine settings without recompiling & re-deploying code. |
| <p/> |
| The value is obtained from the Java System property or configuration setting |
| <code>hbase.test.wait.for.ratio</code> which defaults to <code>1</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - the configuration</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the 'wait for ratio' for the current test run.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="sleep-org.apache.hadoop.conf.Configuration-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sleep</h4> |
| <pre>public static void <a href="../../../../src-html/org/apache/hadoop/hbase/Waiter.html#line.116">sleep</a>(org.apache.hadoop.conf.Configuration conf, |
| long time)</pre> |
| <div class="block">Makes the current thread sleep for the duration equal to the specified time in milliseconds |
| multiplied by the <a href="../../../../org/apache/hadoop/hbase/Waiter.html#getWaitForRatio-org.apache.hadoop.conf.Configuration-"><code>getWaitForRatio(Configuration)</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - the configuration</dd> |
| <dd><code>time</code> - the number of milliseconds to sleep.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="waitFor-org.apache.hadoop.conf.Configuration-long-org.apache.hadoop.hbase.Waiter.Predicate-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>waitFor</h4> |
| <pre>public static <E extends <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>> long <a href="../../../../src-html/org/apache/hadoop/hbase/Waiter.html#line.136">waitFor</a>(org.apache.hadoop.conf.Configuration conf, |
| long timeout, |
| <a href="../../../../org/apache/hadoop/hbase/Waiter.Predicate.html" title="interface in org.apache.hadoop.hbase">Waiter.Predicate</a><E> predicate)</pre> |
| <div class="block">Waits up to the duration equal to the specified timeout multiplied by the |
| <a href="../../../../org/apache/hadoop/hbase/Waiter.html#getWaitForRatio-org.apache.hadoop.conf.Configuration-"><code>getWaitForRatio(Configuration)</code></a> for the given <a href="../../../../org/apache/hadoop/hbase/Waiter.Predicate.html" title="interface in org.apache.hadoop.hbase"><code>Waiter.Predicate</code></a> to become |
| <code>true</code>, failing the test if the timeout is reached and the Predicate is still |
| <code>false</code>. |
| <p/></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - the configuration</dd> |
| <dd><code>timeout</code> - the timeout in milliseconds to wait for the predicate.</dd> |
| <dd><code>predicate</code> - the predicate to evaluate.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the effective wait, in milli-seconds until the predicate becomes <code>true</code> or |
| wait is interrupted otherwise <code>-1</code> when times out</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="waitFor-org.apache.hadoop.conf.Configuration-long-long-org.apache.hadoop.hbase.Waiter.Predicate-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>waitFor</h4> |
| <pre>public static <E extends <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>> long <a href="../../../../src-html/org/apache/hadoop/hbase/Waiter.html#line.154">waitFor</a>(org.apache.hadoop.conf.Configuration conf, |
| long timeout, |
| long interval, |
| <a href="../../../../org/apache/hadoop/hbase/Waiter.Predicate.html" title="interface in org.apache.hadoop.hbase">Waiter.Predicate</a><E> predicate)</pre> |
| <div class="block">Waits up to the duration equal to the specified timeout multiplied by the |
| <a href="../../../../org/apache/hadoop/hbase/Waiter.html#getWaitForRatio-org.apache.hadoop.conf.Configuration-"><code>getWaitForRatio(Configuration)</code></a> for the given <a href="../../../../org/apache/hadoop/hbase/Waiter.Predicate.html" title="interface in org.apache.hadoop.hbase"><code>Waiter.Predicate</code></a> to become |
| <code>true</code>, failing the test if the timeout is reached and the Predicate is still |
| <code>false</code>. |
| <p/></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - the configuration</dd> |
| <dd><code>timeout</code> - the max timeout in milliseconds to wait for the predicate.</dd> |
| <dd><code>interval</code> - the interval in milliseconds to evaluate predicate.</dd> |
| <dd><code>predicate</code> - the predicate to evaluate.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the effective wait, in milli-seconds until the predicate becomes <code>true</code> or |
| wait is interrupted otherwise <code>-1</code> when times out</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="waitFor-org.apache.hadoop.conf.Configuration-long-long-boolean-org.apache.hadoop.hbase.Waiter.Predicate-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>waitFor</h4> |
| <pre>public static <E extends <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>> long <a href="../../../../src-html/org/apache/hadoop/hbase/Waiter.html#line.173">waitFor</a>(org.apache.hadoop.conf.Configuration conf, |
| long timeout, |
| long interval, |
| boolean failIfTimeout, |
| <a href="../../../../org/apache/hadoop/hbase/Waiter.Predicate.html" title="interface in org.apache.hadoop.hbase">Waiter.Predicate</a><E> predicate)</pre> |
| <div class="block">Waits up to the duration equal to the specified timeout multiplied by the |
| <a href="../../../../org/apache/hadoop/hbase/Waiter.html#getWaitForRatio-org.apache.hadoop.conf.Configuration-"><code>getWaitForRatio(Configuration)</code></a> for the given <a href="../../../../org/apache/hadoop/hbase/Waiter.Predicate.html" title="interface in org.apache.hadoop.hbase"><code>Waiter.Predicate</code></a> to become |
| <code>true</code>, failing the test if the timeout is reached, the Predicate is still |
| <code>false</code> and failIfTimeout is set as <code>true</code>. |
| <p/></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - the configuration</dd> |
| <dd><code>timeout</code> - the timeout in milliseconds to wait for the predicate.</dd> |
| <dd><code>interval</code> - the interval in milliseconds to evaluate predicate.</dd> |
| <dd><code>failIfTimeout</code> - indicates if should fail current test case when times out.</dd> |
| <dd><code>predicate</code> - the predicate to evaluate.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the effective wait, in milli-seconds until the predicate becomes <code>true</code> or |
| wait is interrupted otherwise <code>-1</code> when times out</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getExplanation-org.apache.hadoop.hbase.Waiter.Predicate-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getExplanation</h4> |
| <pre>public 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> <a href="../../../../src-html/org/apache/hadoop/hbase/Waiter.html#line.218">getExplanation</a>(<a href="../../../../org/apache/hadoop/hbase/Waiter.Predicate.html" title="interface in org.apache.hadoop.hbase">Waiter.Predicate</a><?> explain)</pre> |
| </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/Waiter.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/hadoop/hbase/TimestampTestBase.FlushCache.html" title="interface in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/hadoop/hbase/Waiter.ExplainingPredicate.html" title="interface in org.apache.hadoop.hbase"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/hadoop/hbase/Waiter.html" target="_top">Frames</a></li> |
| <li><a href="Waiter.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><a href="#nested.class.summary">Nested</a> | </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 © 2007–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
