http://git-wip-us.apache.org/repos/asf/incubator-tephra/blob/49c6e8bd/src/site/resources/apidocs/org/apache/tephra/distributed/ElasticPool.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs/org/apache/tephra/distributed/ElasticPool.html b/src/site/resources/apidocs/org/apache/tephra/distributed/ElasticPool.html new file mode 100644 index 0000000..a7278a4 --- /dev/null +++ b/src/site/resources/apidocs/org/apache/tephra/distributed/ElasticPool.html @@ -0,0 +1,389 @@ +<!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 Mon Sep 19 21:33:27 PDT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ElasticPool (Apache Tephra 0.10.0-incubating-SNAPSHOT API)</title> +<meta name="date" content="2016-09-19"> +<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="ElasticPool (Apache Tephra 0.10.0-incubating-SNAPSHOT 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/ElasticPool.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/tephra/distributed/CloseableThriftClient.html" title="class in org.apache.tephra.distributed"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tephra/distributed/PooledClientProvider.html" title="class in org.apache.tephra.distributed"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tephra/distributed/ElasticPool.html" target="_top">Frames</a></li> +<li><a href="ElasticPool.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>Field | </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>Field | </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.tephra.distributed</div> +<h2 title="Class ElasticPool" class="title">Class ElasticPool<T,E extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>></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.tephra.distributed.ElasticPool<T,E></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - the type of the elements</dd><dd><code>E</code> - the type of exception thrown by create()</dd></dl> +<hr> +<br> +<pre>public abstract class <span class="strong">ElasticPool<T,E extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>></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">An Elastic Pool is an object pool that can dynamically grow. + Normally, an element is obtained by a client and then returned to the pool + after use. However, if the element gets into a bad state, the element can + be discarded, based upon the recycle() method returning false. This will + cause the element to be removed from the pool, and for a subsequent request, + a new element can be created on the fly to replace the discarded one. + + The pool starts with zero (active) elements. Every time a client attempts + to obtain an element, an element from the pool is returned if available. + Otherwise, if the number of active elements is less than the pool's limit, + a new element is created (using abstract method create(), this must be + overridden by all implementations), and the number of active elements is + increased by one. If the limit is reached, then obtain() blocks until + either an element is returned to the pool or, if the obtain method with timeout + parameters is used, a timeout occurs. + + Every time an element is returned to the pool, it is "recycled" to restore its + fresh state for the next use or destroyed, depending on its state.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" 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><strong><a href="../../../../org/apache/tephra/distributed/ElasticPool.html#ElasticPool(int)">ElasticPool</a></strong>(int sizeLimit)</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </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>protected abstract <a href="../../../../org/apache/tephra/distributed/ElasticPool.html" title="type parameter in ElasticPool">T</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/tephra/distributed/ElasticPool.html#create()">create</a></strong>()</code> +<div class="block">A method to create a new element.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/tephra/distributed/ElasticPool.html" title="type parameter in ElasticPool">T</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/tephra/distributed/ElasticPool.html#obtain()">obtain</a></strong>()</code> +<div class="block">Get a element from the pool.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/tephra/distributed/ElasticPool.html" title="type parameter in ElasticPool">T</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/tephra/distributed/ElasticPool.html#obtain(long,%20java.util.concurrent.TimeUnit)">obtain</a></strong>(long timeout, + <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> unit)</code> +<div class="block">Get a element from the pool.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/tephra/distributed/ElasticPool.html#recycle(T)">recycle</a></strong>(<a href="../../../../org/apache/tephra/distributed/ElasticPool.html" title="type parameter in ElasticPool">T</a> element)</code> +<div class="block">A method to recycle an existing element when it is returned to the pool.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/tephra/distributed/ElasticPool.html#release(T)">release</a></strong>(<a href="../../../../org/apache/tephra/distributed/ElasticPool.html" title="type parameter in ElasticPool">T</a> element)</code> +<div class="block">Returns an element to the pool of available elements.</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="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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ElasticPool(int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ElasticPool</h4> +<pre>public ElasticPool(int sizeLimit)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="create()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>create</h4> +<pre>protected abstract <a href="../../../../org/apache/tephra/distributed/ElasticPool.html" title="type parameter in ElasticPool">T</a> create() + throws <a href="../../../../org/apache/tephra/distributed/ElasticPool.html" title="type parameter in ElasticPool">E</a> extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> +<div class="block">A method to create a new element. Will be called every time the pool + of available elements is empty but the limit of active elements is + not exceeded.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a new element</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/tephra/distributed/ElasticPool.html" title="type parameter in ElasticPool">E</a> extends <a href="http://docs.oracle.com/javase/7/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="recycle(java.lang.Object)"> +<!-- --> +</a><a name="recycle(T)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>recycle</h4> +<pre>protected boolean recycle(<a href="../../../../org/apache/tephra/distributed/ElasticPool.html" title="type parameter in ElasticPool">T</a> element)</pre> +<div class="block">A method to recycle an existing element when it is returned to the pool. + This methods ensures that the element is in a fresh state before it can + be reused by the next agent. If the element is not to be returned to the pool, + calling code is responsible for destroying it and returning false.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>element</code> - the element to recycle</dd> +<dt><span class="strong">Returns:</span></dt><dd>true to reuse element, false to remove it from the pool</dd></dl> +</li> +</ul> +<a name="obtain()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>obtain</h4> +<pre>public <a href="../../../../org/apache/tephra/distributed/ElasticPool.html" title="type parameter in ElasticPool">T</a> obtain() + throws <a href="../../../../org/apache/tephra/distributed/ElasticPool.html" title="type parameter in ElasticPool">E</a> extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></pre> +<div class="block">Get a element from the pool. If there is an available element in + the pool, it will be returned. Otherwise, if the number of active + elements does not exceed the limit, a new element is created with + create() and returned. Otherwise, blocks until an element is either + released and returned to the pool, or an element is discarded, + allowing for the creation of a new element.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an element</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/tephra/distributed/ElasticPool.html" title="type parameter in ElasticPool">E</a> extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code></dd></dl> +</li> +</ul> +<a name="obtain(long, java.util.concurrent.TimeUnit)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>obtain</h4> +<pre>public <a href="../../../../org/apache/tephra/distributed/ElasticPool.html" title="type parameter in ElasticPool">T</a> obtain(long timeout, + <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> unit) + throws <a href="../../../../org/apache/tephra/distributed/ElasticPool.html" title="type parameter in ElasticPool">E</a> extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeoutException.html?is-external=true" title="class or interface in java.util.concurrent">TimeoutException</a>, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></pre> +<div class="block">Get a element from the pool. If there is an available element in + the pool, it will be returned. Otherwise, if the number of active + elements does ot exceed the limit, a new element is created with + create() and returned. Otherwise, blocks until an element is either + released and returned to the pool, an element is discarded, + allowing for the creation of a new element, or a timeout occurs.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>timeout</code> - the timeout for trying to obtain an element</dd><dd><code>unit</code> - the timeout unit for trying to obtain an element</dd> +<dt><span class="strong">Returns:</span></dt><dd>an element</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeoutException.html?is-external=true" title="class or interface in java.util.concurrent">TimeoutException</a></code> - if a client is not able to be obtained within the given timeout</dd> +<dd><code><a href="../../../../org/apache/tephra/distributed/ElasticPool.html" title="type parameter in ElasticPool">E</a> extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code></dd></dl> +</li> +</ul> +<a name="release(java.lang.Object)"> +<!-- --> +</a><a name="release(T)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>release</h4> +<pre>public void release(<a href="../../../../org/apache/tephra/distributed/ElasticPool.html" title="type parameter in ElasticPool">T</a> element)</pre> +<div class="block">Returns an element to the pool of available elements. The element must + have been obtained from this pool through obtain(). The recycle() method + is called before the element is available for obtain().</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>element</code> - the element to be returned</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/ElasticPool.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/tephra/distributed/CloseableThriftClient.html" title="class in org.apache.tephra.distributed"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tephra/distributed/PooledClientProvider.html" title="class in org.apache.tephra.distributed"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tephra/distributed/ElasticPool.html" target="_top">Frames</a></li> +<li><a href="ElasticPool.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>Field | </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>Field | </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 © 2016 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-tephra/blob/49c6e8bd/src/site/resources/apidocs/org/apache/tephra/distributed/PooledClientProvider.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs/org/apache/tephra/distributed/PooledClientProvider.html b/src/site/resources/apidocs/org/apache/tephra/distributed/PooledClientProvider.html new file mode 100644 index 0000000..666a01a --- /dev/null +++ b/src/site/resources/apidocs/org/apache/tephra/distributed/PooledClientProvider.html @@ -0,0 +1,360 @@ +<!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 Mon Sep 19 21:33:27 PDT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>PooledClientProvider (Apache Tephra 0.10.0-incubating-SNAPSHOT API)</title> +<meta name="date" content="2016-09-19"> +<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="PooledClientProvider (Apache Tephra 0.10.0-incubating-SNAPSHOT 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/PooledClientProvider.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/tephra/distributed/ElasticPool.html" title="class in org.apache.tephra.distributed"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tephra/distributed/RetryNTimes.html" title="class in org.apache.tephra.distributed"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tephra/distributed/PooledClientProvider.html" target="_top">Frames</a></li> +<li><a href="PooledClientProvider.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_classes_inherited_from_class_org.apache.tephra.distributed.AbstractClientProvider">Nested</a> | </li> +<li><a href="#fields_inherited_from_class_org.apache.tephra.distributed.AbstractClientProvider">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>Field | </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.tephra.distributed</div> +<h2 title="Class PooledClientProvider" class="title">Class PooledClientProvider</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><a href="../../../../org/apache/tephra/distributed/AbstractClientProvider.html" title="class in org.apache.tephra.distributed">org.apache.tephra.distributed.AbstractClientProvider</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.tephra.distributed.PooledClientProvider</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../org/apache/tephra/distributed/ThriftClientProvider.html" title="interface in org.apache.tephra.distributed">ThriftClientProvider</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">PooledClientProvider</span> +extends <a href="../../../../org/apache/tephra/distributed/AbstractClientProvider.html" title="class in org.apache.tephra.distributed">AbstractClientProvider</a></pre> +<div class="block">This is an tx client provider that uses a bounded size pool of connections.</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> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_org.apache.tephra.distributed.AbstractClientProvider"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class org.apache.tephra.distributed.<a href="../../../../org/apache/tephra/distributed/AbstractClientProvider.html" title="class in org.apache.tephra.distributed">AbstractClientProvider</a></h3> +<code><a href="../../../../org/apache/tephra/distributed/AbstractClientProvider.EndpointStrategy.html" title="interface in org.apache.tephra.distributed">AbstractClientProvider.EndpointStrategy</a>, <a href="../../../../org/apache/tephra/distributed/AbstractClientProvider.RandomEndpointStrategy.html" title="class in org.apache.tephra.distributed">AbstractClientProvider.RandomEndpointStrategy</a>, <a href="../../../../org/apache/tephra/distributed/AbstractClientProvider.TimeLimitEndpointStrategy.html" title="class in org.apache.tephra.distributed">AbstractClientProvider.TimeLimitEndpointStrategy</a></code></li> +</ul> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_org.apache.tephra.distributed.AbstractClientProvider"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.tephra.distributed.<a href="../../../../org/apache/tephra/distributed/AbstractClientProvider.html" title="class in org.apache.tephra.distributed">AbstractClientProvider</a></h3> +<code><a href="../../../../org/apache/tephra/distributed/AbstractClientProvider.html#initialized">initialized</a></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" 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><strong><a href="../../../../org/apache/tephra/distributed/PooledClientProvider.html#PooledClientProvider(org.apache.hadoop.conf.Configuration,%20org.apache.twill.discovery.DiscoveryServiceClient)">PooledClientProvider</a></strong>(org.apache.hadoop.conf.Configuration conf, + org.apache.twill.discovery.DiscoveryServiceClient discoveryServiceClient)</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </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><a href="../../../../org/apache/tephra/distributed/CloseableThriftClient.html" title="class in org.apache.tephra.distributed">CloseableThriftClient</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/tephra/distributed/PooledClientProvider.html#getCloseableClient()">getCloseableClient</a></strong>()</code> +<div class="block">Retrieve an AutoCloseable wrapper around tx client for exclusive use by the + current thread.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/tephra/distributed/PooledClientProvider.html#returnClient(org.apache.tephra.distributed.TransactionServiceThriftClient)">returnClient</a></strong>(<a href="../../../../org/apache/tephra/distributed/TransactionServiceThriftClient.html" title="class in org.apache.tephra.distributed">TransactionServiceThriftClient</a> client)</code> +<div class="block">Release an tx client back to the provider's pool, if the client is valid.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/tephra/distributed/PooledClientProvider.html#toString()">toString</a></strong>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.tephra.distributed.AbstractClientProvider"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.tephra.distributed.<a href="../../../../org/apache/tephra/distributed/AbstractClientProvider.html" title="class in org.apache.tephra.distributed">AbstractClientProvider</a></h3> +<code><a href="../../../../org/apache/tephra/distributed/AbstractClientProvider.html#initialize()">initialize</a>, <a href="../../../../org/apache/tephra/distributed/AbstractClientProvider.html#newClient()">newClient</a>, <a href="../../../../org/apache/tephra/distributed/AbstractClientProvider.html#newClient(int)">newClient</a></code></li> +</ul> +<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="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#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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="PooledClientProvider(org.apache.hadoop.conf.Configuration, org.apache.twill.discovery.DiscoveryServiceClient)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PooledClientProvider</h4> +<pre>public PooledClientProvider(org.apache.hadoop.conf.Configuration conf, + org.apache.twill.discovery.DiscoveryServiceClient discoveryServiceClient)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getCloseableClient()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCloseableClient</h4> +<pre>public <a href="../../../../org/apache/tephra/distributed/CloseableThriftClient.html" title="class in org.apache.tephra.distributed">CloseableThriftClient</a> getCloseableClient() + throws org.apache.thrift.TException, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeoutException.html?is-external=true" title="class or interface in java.util.concurrent">TimeoutException</a>, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/tephra/distributed/ThriftClientProvider.html#getCloseableClient()">ThriftClientProvider</a></code></strong></div> +<div class="block">Retrieve an AutoCloseable wrapper around tx client for exclusive use by the + current thread. The client must be closed (returned) to the provider after use.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an tx client, connected and fully functional</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>org.apache.thrift.TException</code></dd> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeoutException.html?is-external=true" title="class or interface in java.util.concurrent">TimeoutException</a></code></dd> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code></dd></dl> +</li> +</ul> +<a name="returnClient(org.apache.tephra.distributed.TransactionServiceThriftClient)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>returnClient</h4> +<pre>public void returnClient(<a href="../../../../org/apache/tephra/distributed/TransactionServiceThriftClient.html" title="class in org.apache.tephra.distributed">TransactionServiceThriftClient</a> client)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/tephra/distributed/ThriftClientProvider.html#returnClient(org.apache.tephra.distributed.TransactionServiceThriftClient)">ThriftClientProvider</a></code></strong></div> +<div class="block">Release an tx client back to the provider's pool, if the client is valid. + If the client becomes disfunctional, for instance, due to a socket + exception. The provider must make sure to close the client, and it + must remove the client from its arsenal and be prepared to create + a new client subsequently.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>client</code> - The client to return</dd></dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><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></code> in class <code><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></code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><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/PooledClientProvider.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/tephra/distributed/ElasticPool.html" title="class in org.apache.tephra.distributed"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tephra/distributed/RetryNTimes.html" title="class in org.apache.tephra.distributed"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tephra/distributed/PooledClientProvider.html" target="_top">Frames</a></li> +<li><a href="PooledClientProvider.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_classes_inherited_from_class_org.apache.tephra.distributed.AbstractClientProvider">Nested</a> | </li> +<li><a href="#fields_inherited_from_class_org.apache.tephra.distributed.AbstractClientProvider">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>Field | </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 © 2016 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-tephra/blob/49c6e8bd/src/site/resources/apidocs/org/apache/tephra/distributed/RetryNTimes.Provider.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs/org/apache/tephra/distributed/RetryNTimes.Provider.html b/src/site/resources/apidocs/org/apache/tephra/distributed/RetryNTimes.Provider.html new file mode 100644 index 0000000..3099658 --- /dev/null +++ b/src/site/resources/apidocs/org/apache/tephra/distributed/RetryNTimes.Provider.html @@ -0,0 +1,314 @@ +<!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 Mon Sep 19 21:33:27 PDT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>RetryNTimes.Provider (Apache Tephra 0.10.0-incubating-SNAPSHOT API)</title> +<meta name="date" content="2016-09-19"> +<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="RetryNTimes.Provider (Apache Tephra 0.10.0-incubating-SNAPSHOT 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/RetryNTimes.Provider.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/tephra/distributed/RetryNTimes.html" title="class in org.apache.tephra.distributed"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tephra/distributed/RetryStrategy.html" title="class in org.apache.tephra.distributed"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tephra/distributed/RetryNTimes.Provider.html" target="_top">Frames</a></li> +<li><a href="RetryNTimes.Provider.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>Field | </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>Field | </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.tephra.distributed</div> +<h2 title="Class RetryNTimes.Provider" class="title">Class RetryNTimes.Provider</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.tephra.distributed.RetryNTimes.Provider</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../org/apache/tephra/distributed/RetryStrategyProvider.html" title="interface in org.apache.tephra.distributed">RetryStrategyProvider</a></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../org/apache/tephra/distributed/RetryNTimes.html" title="class in org.apache.tephra.distributed">RetryNTimes</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="strong">RetryNTimes.Provider</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> +implements <a href="../../../../org/apache/tephra/distributed/RetryStrategyProvider.html" title="interface in org.apache.tephra.distributed">RetryStrategyProvider</a></pre> +<div class="block">A retry strategy provider for this strategy.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" 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><strong><a href="../../../../org/apache/tephra/distributed/RetryNTimes.Provider.html#RetryNTimes.Provider()">RetryNTimes.Provider</a></strong>()</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/tephra/distributed/RetryNTimes.Provider.html#configure(org.apache.hadoop.conf.Configuration)">configure</a></strong>(org.apache.hadoop.conf.Configuration config)</code> +<div class="block">Configure the strategy.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/tephra/distributed/RetryStrategy.html" title="class in org.apache.tephra.distributed">RetryStrategy</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/tephra/distributed/RetryNTimes.Provider.html#newRetryStrategy()">newRetryStrategy</a></strong>()</code> +<div class="block">Provides a new instance of a retry strategy.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/tephra/distributed/RetryNTimes.Provider.html#toString()">toString</a></strong>()</code> </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="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#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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="RetryNTimes.Provider()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>RetryNTimes.Provider</h4> +<pre>public RetryNTimes.Provider()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="configure(org.apache.hadoop.conf.Configuration)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>configure</h4> +<pre>public void configure(org.apache.hadoop.conf.Configuration config)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/tephra/distributed/RetryStrategyProvider.html#configure(org.apache.hadoop.conf.Configuration)">RetryStrategyProvider</a></code></strong></div> +<div class="block">Configure the strategy.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/tephra/distributed/RetryStrategyProvider.html#configure(org.apache.hadoop.conf.Configuration)">configure</a></code> in interface <code><a href="../../../../org/apache/tephra/distributed/RetryStrategyProvider.html" title="interface in org.apache.tephra.distributed">RetryStrategyProvider</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - the configuration</dd></dl> +</li> +</ul> +<a name="newRetryStrategy()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newRetryStrategy</h4> +<pre>public <a href="../../../../org/apache/tephra/distributed/RetryStrategy.html" title="class in org.apache.tephra.distributed">RetryStrategy</a> newRetryStrategy()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/tephra/distributed/RetryStrategyProvider.html#newRetryStrategy()">RetryStrategyProvider</a></code></strong></div> +<div class="block">Provides a new instance of a retry strategy.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/tephra/distributed/RetryStrategyProvider.html#newRetryStrategy()">newRetryStrategy</a></code> in interface <code><a href="../../../../org/apache/tephra/distributed/RetryStrategyProvider.html" title="interface in org.apache.tephra.distributed">RetryStrategyProvider</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>a retry strategy</dd></dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><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></code> in class <code><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></code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><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/RetryNTimes.Provider.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/tephra/distributed/RetryNTimes.html" title="class in org.apache.tephra.distributed"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tephra/distributed/RetryStrategy.html" title="class in org.apache.tephra.distributed"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tephra/distributed/RetryNTimes.Provider.html" target="_top">Frames</a></li> +<li><a href="RetryNTimes.Provider.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>Field | </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>Field | </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 © 2016 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-tephra/blob/49c6e8bd/src/site/resources/apidocs/org/apache/tephra/distributed/RetryNTimes.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs/org/apache/tephra/distributed/RetryNTimes.html b/src/site/resources/apidocs/org/apache/tephra/distributed/RetryNTimes.html new file mode 100644 index 0000000..4f0901e --- /dev/null +++ b/src/site/resources/apidocs/org/apache/tephra/distributed/RetryNTimes.html @@ -0,0 +1,262 @@ +<!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 Mon Sep 19 21:33:27 PDT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>RetryNTimes (Apache Tephra 0.10.0-incubating-SNAPSHOT API)</title> +<meta name="date" content="2016-09-19"> +<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="RetryNTimes (Apache Tephra 0.10.0-incubating-SNAPSHOT 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/RetryNTimes.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/tephra/distributed/PooledClientProvider.html" title="class in org.apache.tephra.distributed"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tephra/distributed/RetryNTimes.Provider.html" title="class in org.apache.tephra.distributed"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tephra/distributed/RetryNTimes.html" target="_top">Frames</a></li> +<li><a href="RetryNTimes.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>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_java.lang.Object">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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.tephra.distributed</div> +<h2 title="Class RetryNTimes" class="title">Class RetryNTimes</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><a href="../../../../org/apache/tephra/distributed/RetryStrategy.html" title="class in org.apache.tephra.distributed">org.apache.tephra.distributed.RetryStrategy</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.tephra.distributed.RetryNTimes</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">RetryNTimes</span> +extends <a href="../../../../org/apache/tephra/distributed/RetryStrategy.html" title="class in org.apache.tephra.distributed">RetryStrategy</a></pre> +<div class="block">A retry strategy that makes N attempts and then gives up. This does + not do anything before the re-attempt - extend this class to add a + sleep or similar.</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="overviewSummary" 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 class </code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/tephra/distributed/RetryNTimes.Provider.html" title="class in org.apache.tephra.distributed">RetryNTimes.Provider</a></strong></code> +<div class="block">A retry strategy provider for this strategy.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" 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>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/tephra/distributed/RetryNTimes.html#RetryNTimes(int)">RetryNTimes</a></strong>(int maxAttempts)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<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="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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="RetryNTimes(int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>RetryNTimes</h4> +<pre>protected RetryNTimes(int maxAttempts)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>maxAttempts</code> - the number of attempts after which to stop</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/RetryNTimes.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/tephra/distributed/PooledClientProvider.html" title="class in org.apache.tephra.distributed"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tephra/distributed/RetryNTimes.Provider.html" title="class in org.apache.tephra.distributed"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tephra/distributed/RetryNTimes.html" target="_top">Frames</a></li> +<li><a href="RetryNTimes.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>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_java.lang.Object">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2016 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-tephra/blob/49c6e8bd/src/site/resources/apidocs/org/apache/tephra/distributed/RetryStrategy.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs/org/apache/tephra/distributed/RetryStrategy.html b/src/site/resources/apidocs/org/apache/tephra/distributed/RetryStrategy.html new file mode 100644 index 0000000..f26c471 --- /dev/null +++ b/src/site/resources/apidocs/org/apache/tephra/distributed/RetryStrategy.html @@ -0,0 +1,236 @@ +<!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 Mon Sep 19 21:33:27 PDT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>RetryStrategy (Apache Tephra 0.10.0-incubating-SNAPSHOT API)</title> +<meta name="date" content="2016-09-19"> +<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="RetryStrategy (Apache Tephra 0.10.0-incubating-SNAPSHOT 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/RetryStrategy.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/tephra/distributed/RetryNTimes.Provider.html" title="class in org.apache.tephra.distributed"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tephra/distributed/RetryStrategyProvider.html" title="interface in org.apache.tephra.distributed"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tephra/distributed/RetryStrategy.html" target="_top">Frames</a></li> +<li><a href="RetryStrategy.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>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_java.lang.Object">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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.tephra.distributed</div> +<h2 title="Class RetryStrategy" class="title">Class RetryStrategy</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.tephra.distributed.RetryStrategy</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../org/apache/tephra/distributed/RetryNTimes.html" title="class in org.apache.tephra.distributed">RetryNTimes</a>, <a href="../../../../org/apache/tephra/distributed/RetryWithBackoff.html" title="class in org.apache.tephra.distributed">RetryWithBackoff</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">RetryStrategy</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">A retry strategy is an abstraction over how the remote tx client shuold retry operations after connection + failures.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" 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><strong><a href="../../../../org/apache/tephra/distributed/RetryStrategy.html#RetryStrategy()">RetryStrategy</a></strong>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<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="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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="RetryStrategy()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>RetryStrategy</h4> +<pre>public RetryStrategy()</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><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/RetryStrategy.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/tephra/distributed/RetryNTimes.Provider.html" title="class in org.apache.tephra.distributed"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tephra/distributed/RetryStrategyProvider.html" title="interface in org.apache.tephra.distributed"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tephra/distributed/RetryStrategy.html" target="_top">Frames</a></li> +<li><a href="RetryStrategy.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>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_java.lang.Object">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2016 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>