Google Git
Sign in
apache / twill / 597141723af7c306d2b7be485dd187bc56c10b12 / . / src / site / resources / apidocs-0.11.0 / org / apache / twill / zookeeper / RetryStrategies.html
blob: 22555459465ea090e4897ae1cc7f283feb53046c [file] [log] [blame]
<!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 (version 1.7.0_80) on Sat Apr 08 11:09:16 PDT 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>RetryStrategies (Apache Twill 0.11.0 API)</title>
<meta name="date" content="2017-04-08">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="RetryStrategies (Apache Twill 0.11.0 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/RetryStrategies.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/twill/zookeeper/OperationFuture.html" title="interface in org.apache.twill.zookeeper"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/twill/zookeeper/RetryStrategies.html" target="_top">Frames</a></li>
<li><a href="RetryStrategies.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.twill.zookeeper</div>
<h2 title="Class RetryStrategies" class="title">Class RetryStrategies</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/7/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.twill.zookeeper.RetryStrategies</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="strong">RetryStrategies</span>
extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Factory for creating common <a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper"><code>RetryStrategy</code></a> implementation.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper">RetryStrategy</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/twill/zookeeper/RetryStrategies.html#exponentialDelay(long,%20long,%20java.util.concurrent.TimeUnit)">exponentialDelay</a></strong>(long&nbsp;baseDelay,
long&nbsp;maxDelay,
<a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a>&nbsp;delayUnit)</code>
<div class="block">Creates a <a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper"><code>RetryStrategy</code></a> that will increase delay exponentially between each retries.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper">RetryStrategy</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/twill/zookeeper/RetryStrategies.html#fixDelay(long,%20java.util.concurrent.TimeUnit)">fixDelay</a></strong>(long&nbsp;delay,
<a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a>&nbsp;delayUnit)</code>
<div class="block">Creates a <a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper"><code>RetryStrategy</code></a> that imposes a fix delay between each retries.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper">RetryStrategy</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/twill/zookeeper/RetryStrategies.html#limit(int,%20org.apache.twill.zookeeper.RetryStrategy)">limit</a></strong>(int&nbsp;limit,
<a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper">RetryStrategy</a>&nbsp;strategy)</code>
<div class="block">Creates a <a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper"><code>RetryStrategy</code></a> that retries maximum given number of times, with the actual
delay behavior delegated to another <a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper"><code>RetryStrategy</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper">RetryStrategy</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/twill/zookeeper/RetryStrategies.html#noRetry()">noRetry</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper">RetryStrategy</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/twill/zookeeper/RetryStrategies.html#timeLimit(long,%20java.util.concurrent.TimeUnit,%20org.apache.twill.zookeeper.RetryStrategy)">timeLimit</a></strong>(long&nbsp;maxElapseTime,
<a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a>&nbsp;timeUnit,
<a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper">RetryStrategy</a>&nbsp;strategy)</code>
<div class="block">Creates a <a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper"><code>RetryStrategy</code></a> that will retry until maximum amount of time has been passed since the request,
with the actual delay behavior delegated to another <a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper"><code>RetryStrategy</code></a>.</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&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/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://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" 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">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="noRetry()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>noRetry</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper">RetryStrategy</a>&nbsp;noRetry()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>A <a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper"><code>RetryStrategy</code></a> that doesn't do any retry.</dd></dl>
</li>
</ul>
<a name="limit(int, org.apache.twill.zookeeper.RetryStrategy)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>limit</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper">RetryStrategy</a>&nbsp;limit(int&nbsp;limit,
<a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper">RetryStrategy</a>&nbsp;strategy)</pre>
<div class="block">Creates a <a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper"><code>RetryStrategy</code></a> that retries maximum given number of times, with the actual
delay behavior delegated to another <a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper"><code>RetryStrategy</code></a>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>limit</code> - Maximum number of retries allowed.</dd><dd><code>strategy</code> - When failure count is less than or equal to the limit, this strategy will be called.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A <a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper"><code>RetryStrategy</code></a>.</dd></dl>
</li>
</ul>
<a name="fixDelay(long, java.util.concurrent.TimeUnit)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fixDelay</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper">RetryStrategy</a>&nbsp;fixDelay(long&nbsp;delay,
<a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a>&nbsp;delayUnit)</pre>
<div class="block">Creates a <a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper"><code>RetryStrategy</code></a> that imposes a fix delay between each retries.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>delay</code> - delay time</dd><dd><code>delayUnit</code> - <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent"><code>TimeUnit</code></a> for the delay.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A <a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper"><code>RetryStrategy</code></a>.</dd></dl>
</li>
</ul>
<a name="exponentialDelay(long, long, java.util.concurrent.TimeUnit)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>exponentialDelay</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper">RetryStrategy</a>&nbsp;exponentialDelay(long&nbsp;baseDelay,
long&nbsp;maxDelay,
<a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a>&nbsp;delayUnit)</pre>
<div class="block">Creates a <a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper"><code>RetryStrategy</code></a> that will increase delay exponentially between each retries.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>baseDelay</code> - delay to start with.</dd><dd><code>maxDelay</code> - cap of the delay.</dd><dd><code>delayUnit</code> - <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent"><code>TimeUnit</code></a> for the delays.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A <a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper"><code>RetryStrategy</code></a>.</dd></dl>
</li>
</ul>
<a name="timeLimit(long, java.util.concurrent.TimeUnit, org.apache.twill.zookeeper.RetryStrategy)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>timeLimit</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper">RetryStrategy</a>&nbsp;timeLimit(long&nbsp;maxElapseTime,
<a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a>&nbsp;timeUnit,
<a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper">RetryStrategy</a>&nbsp;strategy)</pre>
<div class="block">Creates a <a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper"><code>RetryStrategy</code></a> that will retry until maximum amount of time has been passed since the request,
with the actual delay behavior delegated to another <a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper"><code>RetryStrategy</code></a>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>maxElapseTime</code> - Maximum amount of time until giving up retry.</dd><dd><code>timeUnit</code> - <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent"><code>TimeUnit</code></a> for the max elapse time.</dd><dd><code>strategy</code> - When time elapsed is less than or equal to the limit, this strategy will be called.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A <a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper"><code>RetryStrategy</code></a>.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/RetryStrategies.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/twill/zookeeper/OperationFuture.html" title="interface in org.apache.twill.zookeeper"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/twill/zookeeper/RetryStrategies.html" target="_top">Frames</a></li>
<li><a href="RetryStrategies.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2013-2016 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>