http://git-wip-us.apache.org/repos/asf/incubator-tephra/blob/4e1e5e9a/src/site/resources/apidocs-0.13.0-incubating/org/apache/tephra/distributed/RetryWithBackoff.Provider.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs-0.13.0-incubating/org/apache/tephra/distributed/RetryWithBackoff.Provider.html b/src/site/resources/apidocs-0.13.0-incubating/org/apache/tephra/distributed/RetryWithBackoff.Provider.html new file mode 100644 index 0000000..bfda467 --- /dev/null +++ b/src/site/resources/apidocs-0.13.0-incubating/org/apache/tephra/distributed/RetryWithBackoff.Provider.html @@ -0,0 +1,333 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_60) on Thu Sep 21 16:46:18 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>RetryWithBackoff.Provider (Apache Tephra 0.13.0-incubating API)</title> +<meta name="date" content="2017-09-21"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="RetryWithBackoff.Provider (Apache Tephra 0.13.0-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/RetryWithBackoff.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/RetryWithBackoff.html" title="class in org.apache.tephra.distributed"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tephra/distributed/SingleUseClientProvider.html" title="class in org.apache.tephra.distributed"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tephra/distributed/RetryWithBackoff.Provider.html" target="_top">Frames</a></li> +<li><a href="RetryWithBackoff.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 RetryWithBackoff.Provider" class="title">Class RetryWithBackoff.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.RetryWithBackoff.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/RetryWithBackoff.html" title="class in org.apache.tephra.distributed">RetryWithBackoff</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="typeNameLabel">RetryWithBackoff.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 provider for this retry 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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/tephra/distributed/RetryWithBackoff.Provider.html#Provider--">Provider</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tephra/distributed/RetryWithBackoff.Provider.html#configure-org.apache.hadoop.conf.Configuration-">configure</a></span>(org.apache.hadoop.conf.Configuration config)</code> +<div class="block">Configure the strategy.</div> +</td> +</tr> +<tr id="i1" 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><span class="memberNameLink"><a href="../../../../org/apache/tephra/distributed/RetryWithBackoff.Provider.html#newRetryStrategy--">newRetryStrategy</a></span>()</code> +<div class="block">Provides a new instance of a retry strategy.</div> +</td> +</tr> +<tr id="i2" 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><span class="memberNameLink"><a href="../../../../org/apache/tephra/distributed/RetryWithBackoff.Provider.html#toString--">toString</a></span>()</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-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="Provider--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Provider</h4> +<pre>public 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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/tephra/distributed/RetryStrategyProvider.html#configure-org.apache.hadoop.conf.Configuration-">RetryStrategyProvider</a></code></span></div> +<div class="block">Configure the strategy.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></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="paramLabel">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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/tephra/distributed/RetryStrategyProvider.html#newRetryStrategy--">RetryStrategyProvider</a></code></span></div> +<div class="block">Provides a new instance of a retry strategy.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></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="returnLabel">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><span class="overrideSpecifyLabel">Overrides:</span></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> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/RetryWithBackoff.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/RetryWithBackoff.html" title="class in org.apache.tephra.distributed"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tephra/distributed/SingleUseClientProvider.html" title="class in org.apache.tephra.distributed"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tephra/distributed/RetryWithBackoff.Provider.html" target="_top">Frames</a></li> +<li><a href="RetryWithBackoff.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 © 2017 <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/4e1e5e9a/src/site/resources/apidocs-0.13.0-incubating/org/apache/tephra/distributed/RetryWithBackoff.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs-0.13.0-incubating/org/apache/tephra/distributed/RetryWithBackoff.html b/src/site/resources/apidocs-0.13.0-incubating/org/apache/tephra/distributed/RetryWithBackoff.html new file mode 100644 index 0000000..31e95d0 --- /dev/null +++ b/src/site/resources/apidocs-0.13.0-incubating/org/apache/tephra/distributed/RetryWithBackoff.html @@ -0,0 +1,301 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_60) on Thu Sep 21 16:46:18 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>RetryWithBackoff (Apache Tephra 0.13.0-incubating API)</title> +<meta name="date" content="2017-09-21"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="RetryWithBackoff (Apache Tephra 0.13.0-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/RetryWithBackoff.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/RetryStrategyProvider.html" title="interface in org.apache.tephra.distributed"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tephra/distributed/RetryWithBackoff.Provider.html" title="class in org.apache.tephra.distributed"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tephra/distributed/RetryWithBackoff.html" target="_top">Frames</a></li> +<li><a href="RetryWithBackoff.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 RetryWithBackoff" class="title">Class RetryWithBackoff</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.RetryWithBackoff</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">RetryWithBackoff</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tephra/distributed/RetryWithBackoff.Provider.html" title="class in org.apache.tephra.distributed">RetryWithBackoff.Provider</a></span></code> +<div class="block">A provider for this retry strategy.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tephra/distributed/RetryWithBackoff.html#beforeRetry--">beforeRetry</a></span>()</code> +<div class="block">Should be called before re-attempting.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tephra/distributed/RetryWithBackoff.html#failOnce--">failOnce</a></span>()</code> +<div class="block">Increments the number of failed attempts.</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-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="failOnce--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>failOnce</h4> +<pre>public boolean failOnce()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/tephra/distributed/RetryStrategy.html#failOnce--">RetryStrategy</a></code></span></div> +<div class="block">Increments the number of failed attempts.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/tephra/distributed/RetryStrategy.html#failOnce--">failOnce</a></code> in class <code><a href="../../../../org/apache/tephra/distributed/RetryStrategy.html" title="class in org.apache.tephra.distributed">RetryStrategy</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>whether another attempt should be made</dd> +</dl> +</li> +</ul> +<a name="beforeRetry--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>beforeRetry</h4> +<pre>public void beforeRetry()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/tephra/distributed/RetryStrategy.html#beforeRetry--">RetryStrategy</a></code></span></div> +<div class="block">Should be called before re-attempting. This can, for instance + inject a sleep time between retries. Default implementation is + to do nothing.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../org/apache/tephra/distributed/RetryStrategy.html#beforeRetry--">beforeRetry</a></code> in class <code><a href="../../../../org/apache/tephra/distributed/RetryStrategy.html" title="class in org.apache.tephra.distributed">RetryStrategy</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> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/RetryWithBackoff.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/RetryStrategyProvider.html" title="interface in org.apache.tephra.distributed"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tephra/distributed/RetryWithBackoff.Provider.html" title="class in org.apache.tephra.distributed"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tephra/distributed/RetryWithBackoff.html" target="_top">Frames</a></li> +<li><a href="RetryWithBackoff.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 © 2017 <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/4e1e5e9a/src/site/resources/apidocs-0.13.0-incubating/org/apache/tephra/distributed/SingleUseClientProvider.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs-0.13.0-incubating/org/apache/tephra/distributed/SingleUseClientProvider.html b/src/site/resources/apidocs-0.13.0-incubating/org/apache/tephra/distributed/SingleUseClientProvider.html new file mode 100644 index 0000000..18f8992 --- /dev/null +++ b/src/site/resources/apidocs-0.13.0-incubating/org/apache/tephra/distributed/SingleUseClientProvider.html @@ -0,0 +1,383 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_60) on Thu Sep 21 16:46:18 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>SingleUseClientProvider (Apache Tephra 0.13.0-incubating API)</title> +<meta name="date" content="2017-09-21"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SingleUseClientProvider (Apache Tephra 0.13.0-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/SingleUseClientProvider.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/RetryWithBackoff.Provider.html" title="class in org.apache.tephra.distributed"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tephra/distributed/ThreadLocalClientProvider.html" title="class in org.apache.tephra.distributed"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tephra/distributed/SingleUseClientProvider.html" target="_top">Frames</a></li> +<li><a href="SingleUseClientProvider.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 SingleUseClientProvider" class="title">Class SingleUseClientProvider</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.SingleUseClientProvider</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="typeNameLabel">SingleUseClientProvider</span> +extends <a href="../../../../org/apache/tephra/distributed/AbstractClientProvider.html" title="class in org.apache.tephra.distributed">AbstractClientProvider</a></pre> +<div class="block">An tx client provider that creates a new connection every time.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/tephra/distributed/SingleUseClientProvider.html#SingleUseClientProvider-org.apache.hadoop.conf.Configuration-org.apache.twill.discovery.DiscoveryServiceClient-int-">SingleUseClientProvider</a></span>(org.apache.hadoop.conf.Configuration conf, + org.apache.twill.discovery.DiscoveryServiceClient discoveryServiceClient, + int timeout)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/tephra/distributed/CloseableThriftClient.html" title="class in org.apache.tephra.distributed">CloseableThriftClient</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tephra/distributed/SingleUseClientProvider.html#getCloseableClient--">getCloseableClient</a></span>()</code> +<div class="block">Retrieve an AutoCloseable wrapper around tx client for exclusive use by the + current thread.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tephra/distributed/SingleUseClientProvider.html#returnClient-org.apache.tephra.distributed.TransactionServiceThriftClient-">returnClient</a></span>(<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 id="i2" 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><span class="memberNameLink"><a href="../../../../org/apache/tephra/distributed/SingleUseClientProvider.html#toString--">toString</a></span>()</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-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="SingleUseClientProvider-org.apache.hadoop.conf.Configuration-org.apache.twill.discovery.DiscoveryServiceClient-int-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SingleUseClientProvider</h4> +<pre>public SingleUseClientProvider(org.apache.hadoop.conf.Configuration conf, + org.apache.twill.discovery.DiscoveryServiceClient discoveryServiceClient, + int timeout)</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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/tephra/distributed/ThriftClientProvider.html#getCloseableClient--">ThriftClientProvider</a></code></span></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="returnLabel">Returns:</span></dt> +<dd>an tx client, connected and fully functional</dd> +<dt><span class="throwsLabel">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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/tephra/distributed/ThriftClientProvider.html#returnClient-org.apache.tephra.distributed.TransactionServiceThriftClient-">ThriftClientProvider</a></code></span></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="paramLabel">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><span class="overrideSpecifyLabel">Overrides:</span></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> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/SingleUseClientProvider.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/RetryWithBackoff.Provider.html" title="class in org.apache.tephra.distributed"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tephra/distributed/ThreadLocalClientProvider.html" title="class in org.apache.tephra.distributed"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tephra/distributed/SingleUseClientProvider.html" target="_top">Frames</a></li> +<li><a href="SingleUseClientProvider.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 © 2017 <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/4e1e5e9a/src/site/resources/apidocs-0.13.0-incubating/org/apache/tephra/distributed/ThreadLocalClientProvider.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs-0.13.0-incubating/org/apache/tephra/distributed/ThreadLocalClientProvider.html b/src/site/resources/apidocs-0.13.0-incubating/org/apache/tephra/distributed/ThreadLocalClientProvider.html new file mode 100644 index 0000000..6c4a30c --- /dev/null +++ b/src/site/resources/apidocs-0.13.0-incubating/org/apache/tephra/distributed/ThreadLocalClientProvider.html @@ -0,0 +1,382 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_60) on Thu Sep 21 16:46:18 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ThreadLocalClientProvider (Apache Tephra 0.13.0-incubating API)</title> +<meta name="date" content="2017-09-21"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ThreadLocalClientProvider (Apache Tephra 0.13.0-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ThreadLocalClientProvider.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/SingleUseClientProvider.html" title="class in org.apache.tephra.distributed"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tephra/distributed/ThriftClientProvider.html" title="interface in org.apache.tephra.distributed"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tephra/distributed/ThreadLocalClientProvider.html" target="_top">Frames</a></li> +<li><a href="ThreadLocalClientProvider.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 ThreadLocalClientProvider" class="title">Class ThreadLocalClientProvider</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.ThreadLocalClientProvider</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="typeNameLabel">ThreadLocalClientProvider</span> +extends <a href="../../../../org/apache/tephra/distributed/AbstractClientProvider.html" title="class in org.apache.tephra.distributed">AbstractClientProvider</a></pre> +<div class="block">An tx client provider that uses thread local to maintain at most one open connection per thread. + Note that there can be a connection leak if the threads are recycled.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/tephra/distributed/ThreadLocalClientProvider.html#ThreadLocalClientProvider-org.apache.hadoop.conf.Configuration-org.apache.twill.discovery.DiscoveryServiceClient-">ThreadLocalClientProvider</a></span>(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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/tephra/distributed/CloseableThriftClient.html" title="class in org.apache.tephra.distributed">CloseableThriftClient</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tephra/distributed/ThreadLocalClientProvider.html#getCloseableClient--">getCloseableClient</a></span>()</code> +<div class="block">Retrieve an AutoCloseable wrapper around tx client for exclusive use by the + current thread.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tephra/distributed/ThreadLocalClientProvider.html#returnClient-org.apache.tephra.distributed.TransactionServiceThriftClient-">returnClient</a></span>(<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 id="i2" 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><span class="memberNameLink"><a href="../../../../org/apache/tephra/distributed/ThreadLocalClientProvider.html#toString--">toString</a></span>()</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-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ThreadLocalClientProvider-org.apache.hadoop.conf.Configuration-org.apache.twill.discovery.DiscoveryServiceClient-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ThreadLocalClientProvider</h4> +<pre>public ThreadLocalClientProvider(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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/tephra/distributed/ThriftClientProvider.html#getCloseableClient--">ThriftClientProvider</a></code></span></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="returnLabel">Returns:</span></dt> +<dd>an tx client, connected and fully functional</dd> +<dt><span class="throwsLabel">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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/tephra/distributed/ThriftClientProvider.html#returnClient-org.apache.tephra.distributed.TransactionServiceThriftClient-">ThriftClientProvider</a></code></span></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="paramLabel">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><span class="overrideSpecifyLabel">Overrides:</span></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> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ThreadLocalClientProvider.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/SingleUseClientProvider.html" title="class in org.apache.tephra.distributed"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tephra/distributed/ThriftClientProvider.html" title="interface in org.apache.tephra.distributed"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tephra/distributed/ThreadLocalClientProvider.html" target="_top">Frames</a></li> +<li><a href="ThreadLocalClientProvider.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 © 2017 <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/4e1e5e9a/src/site/resources/apidocs-0.13.0-incubating/org/apache/tephra/distributed/ThriftClientProvider.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs-0.13.0-incubating/org/apache/tephra/distributed/ThriftClientProvider.html b/src/site/resources/apidocs-0.13.0-incubating/org/apache/tephra/distributed/ThriftClientProvider.html new file mode 100644 index 0000000..dcdf61b --- /dev/null +++ b/src/site/resources/apidocs-0.13.0-incubating/org/apache/tephra/distributed/ThriftClientProvider.html @@ -0,0 +1,303 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_60) on Thu Sep 21 16:46:18 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ThriftClientProvider (Apache Tephra 0.13.0-incubating API)</title> +<meta name="date" content="2017-09-21"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ThriftClientProvider (Apache Tephra 0.13.0-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ThriftClientProvider.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/ThreadLocalClientProvider.html" title="class in org.apache.tephra.distributed"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tephra/distributed/TransactionConverterUtils.html" title="class in org.apache.tephra.distributed"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tephra/distributed/ThriftClientProvider.html" target="_top">Frames</a></li> +<li><a href="ThriftClientProvider.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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="Interface ThriftClientProvider" class="title">Interface ThriftClientProvider</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../org/apache/tephra/distributed/AbstractClientProvider.html" title="class in org.apache.tephra.distributed">AbstractClientProvider</a>, <a href="../../../../org/apache/tephra/distributed/PooledClientProvider.html" title="class in org.apache.tephra.distributed">PooledClientProvider</a>, <a href="../../../../org/apache/tephra/distributed/SingleUseClientProvider.html" title="class in org.apache.tephra.distributed">SingleUseClientProvider</a>, <a href="../../../../org/apache/tephra/distributed/ThreadLocalClientProvider.html" title="class in org.apache.tephra.distributed">ThreadLocalClientProvider</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">ThriftClientProvider</span></pre> +<div class="block">This interface is used to provide thrift tx service clients: + there is only one (singleton) + tx service per JVM, but many threads may use it concurrently. + However, being a thrift client, it is not thread-safe. In + order to avoid serializing all tx calls by synchronizing + on the tx service client, we employ a pool of clients. But + in different scenarios there are different strategies for + pooling: If there are many short-lived threads, it is wise + to have a shared pool between all threads. But if there are + few long-lived threads, it may be better to have thread-local + client for each thread. + + This interface provides an abstraction of the pooling strategy.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/tephra/distributed/CloseableThriftClient.html" title="class in org.apache.tephra.distributed">CloseableThriftClient</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tephra/distributed/ThriftClientProvider.html#getCloseableClient--">getCloseableClient</a></span>()</code> +<div class="block">Retrieve an AutoCloseable wrapper around tx client for exclusive use by the + current thread.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tephra/distributed/ThriftClientProvider.html#initialize--">initialize</a></span>()</code> +<div class="block">Initialize the provider.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tephra/distributed/ThriftClientProvider.html#returnClient-org.apache.tephra.distributed.TransactionServiceThriftClient-">returnClient</a></span>(<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> +</table> +</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="initialize--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>initialize</h4> +<pre>void initialize() + throws org.apache.thrift.TException</pre> +<div class="block">Initialize the provider. At this point, it should be verified + that tx service is up and running and getClient() can + create new clients when necessary.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.thrift.TException</code></dd> +</dl> +</li> +</ul> +<a name="getCloseableClient--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCloseableClient</h4> +<pre><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">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="returnLabel">Returns:</span></dt> +<dd>an tx client, connected and fully functional</dd> +<dt><span class="throwsLabel">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="blockListLast"> +<li class="blockList"> +<h4>returnClient</h4> +<pre>void returnClient(<a href="../../../../org/apache/tephra/distributed/TransactionServiceThriftClient.html" title="class in org.apache.tephra.distributed">TransactionServiceThriftClient</a> client)</pre> +<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="paramLabel">Parameters:</span></dt> +<dd><code>client</code> - The client to return</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> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ThriftClientProvider.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/ThreadLocalClientProvider.html" title="class in org.apache.tephra.distributed"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tephra/distributed/TransactionConverterUtils.html" title="class in org.apache.tephra.distributed"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tephra/distributed/ThriftClientProvider.html" target="_top">Frames</a></li> +<li><a href="ThriftClientProvider.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 © 2017 <a href="http://www.apache.org";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
