| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.hadoop.hbase.util, class: RetryCounter"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">/*</span> |
| <span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span> |
| <span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span> |
| <span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span> |
| <span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span> |
| <span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span> |
| <span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span> |
| <span class="source-line-no">009</span><span id="line-9"> *</span> |
| <span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="source-line-no">011</span><span id="line-11"> *</span> |
| <span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span> |
| <span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span> |
| <span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span> |
| <span class="source-line-no">017</span><span id="line-17"> */</span> |
| <span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.util;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import java.util.concurrent.ThreadLocalRandom;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.util.concurrent.TimeUnit;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.slf4j.Logger;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">025</span><span id="line-25"></span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hbase.thirdparty.com.google.common.base.Preconditions;</span> |
| <span class="source-line-no">027</span><span id="line-27"></span> |
| <span class="source-line-no">028</span><span id="line-28">/**</span> |
| <span class="source-line-no">029</span><span id="line-29"> * Operation retry accounting. Use to calculate wait period,</span> |
| <span class="source-line-no">030</span><span id="line-30"> * {@link #getBackoffTimeAndIncrementAttempts()}}, or for performing wait,</span> |
| <span class="source-line-no">031</span><span id="line-31"> * {@link #sleepUntilNextRetry()}, in accordance with a {@link RetryConfig}, initial settings, and a</span> |
| <span class="source-line-no">032</span><span id="line-32"> * Retry Policy, (See org.apache.hadoop.io.retry.RetryPolicy). Like <a</span> |
| <span class="source-line-no">033</span><span id="line-33"> * href=https://github.com/rholder/guava-retrying>guava-retrying</a>.</span> |
| <span class="source-line-no">034</span><span id="line-34"> * @since 0.92.0</span> |
| <span class="source-line-no">035</span><span id="line-35"> * @see RetryCounterFactory</span> |
| <span class="source-line-no">036</span><span id="line-36"> */</span> |
| <span class="source-line-no">037</span><span id="line-37">@InterfaceAudience.Private</span> |
| <span class="source-line-no">038</span><span id="line-38">public class RetryCounter {</span> |
| <span class="source-line-no">039</span><span id="line-39"> /**</span> |
| <span class="source-line-no">040</span><span id="line-40"> * Configuration for a retry counter</span> |
| <span class="source-line-no">041</span><span id="line-41"> */</span> |
| <span class="source-line-no">042</span><span id="line-42"> public static class RetryConfig {</span> |
| <span class="source-line-no">043</span><span id="line-43"> private int maxAttempts;</span> |
| <span class="source-line-no">044</span><span id="line-44"> private long sleepInterval;</span> |
| <span class="source-line-no">045</span><span id="line-45"> private long maxSleepTime;</span> |
| <span class="source-line-no">046</span><span id="line-46"> private TimeUnit timeUnit;</span> |
| <span class="source-line-no">047</span><span id="line-47"> private BackoffPolicy backoffPolicy;</span> |
| <span class="source-line-no">048</span><span id="line-48"> private float jitter;</span> |
| <span class="source-line-no">049</span><span id="line-49"></span> |
| <span class="source-line-no">050</span><span id="line-50"> private static final BackoffPolicy DEFAULT_BACKOFF_POLICY = new ExponentialBackoffPolicy();</span> |
| <span class="source-line-no">051</span><span id="line-51"></span> |
| <span class="source-line-no">052</span><span id="line-52"> public RetryConfig() {</span> |
| <span class="source-line-no">053</span><span id="line-53"> maxAttempts = 1;</span> |
| <span class="source-line-no">054</span><span id="line-54"> sleepInterval = 1000;</span> |
| <span class="source-line-no">055</span><span id="line-55"> maxSleepTime = -1;</span> |
| <span class="source-line-no">056</span><span id="line-56"> timeUnit = TimeUnit.MILLISECONDS;</span> |
| <span class="source-line-no">057</span><span id="line-57"> backoffPolicy = DEFAULT_BACKOFF_POLICY;</span> |
| <span class="source-line-no">058</span><span id="line-58"> jitter = 0.0f;</span> |
| <span class="source-line-no">059</span><span id="line-59"> }</span> |
| <span class="source-line-no">060</span><span id="line-60"></span> |
| <span class="source-line-no">061</span><span id="line-61"> public RetryConfig(int maxAttempts, long sleepInterval, long maxSleepTime, TimeUnit timeUnit,</span> |
| <span class="source-line-no">062</span><span id="line-62"> BackoffPolicy backoffPolicy) {</span> |
| <span class="source-line-no">063</span><span id="line-63"> this.maxAttempts = maxAttempts;</span> |
| <span class="source-line-no">064</span><span id="line-64"> this.sleepInterval = sleepInterval;</span> |
| <span class="source-line-no">065</span><span id="line-65"> this.maxSleepTime = maxSleepTime;</span> |
| <span class="source-line-no">066</span><span id="line-66"> this.timeUnit = timeUnit;</span> |
| <span class="source-line-no">067</span><span id="line-67"> this.backoffPolicy = backoffPolicy;</span> |
| <span class="source-line-no">068</span><span id="line-68"> }</span> |
| <span class="source-line-no">069</span><span id="line-69"></span> |
| <span class="source-line-no">070</span><span id="line-70"> public RetryConfig setBackoffPolicy(BackoffPolicy backoffPolicy) {</span> |
| <span class="source-line-no">071</span><span id="line-71"> this.backoffPolicy = backoffPolicy;</span> |
| <span class="source-line-no">072</span><span id="line-72"> return this;</span> |
| <span class="source-line-no">073</span><span id="line-73"> }</span> |
| <span class="source-line-no">074</span><span id="line-74"></span> |
| <span class="source-line-no">075</span><span id="line-75"> public RetryConfig setMaxAttempts(int maxAttempts) {</span> |
| <span class="source-line-no">076</span><span id="line-76"> this.maxAttempts = maxAttempts;</span> |
| <span class="source-line-no">077</span><span id="line-77"> return this;</span> |
| <span class="source-line-no">078</span><span id="line-78"> }</span> |
| <span class="source-line-no">079</span><span id="line-79"></span> |
| <span class="source-line-no">080</span><span id="line-80"> public RetryConfig setMaxSleepTime(long maxSleepTime) {</span> |
| <span class="source-line-no">081</span><span id="line-81"> this.maxSleepTime = maxSleepTime;</span> |
| <span class="source-line-no">082</span><span id="line-82"> return this;</span> |
| <span class="source-line-no">083</span><span id="line-83"> }</span> |
| <span class="source-line-no">084</span><span id="line-84"></span> |
| <span class="source-line-no">085</span><span id="line-85"> public RetryConfig setSleepInterval(long sleepInterval) {</span> |
| <span class="source-line-no">086</span><span id="line-86"> this.sleepInterval = sleepInterval;</span> |
| <span class="source-line-no">087</span><span id="line-87"> return this;</span> |
| <span class="source-line-no">088</span><span id="line-88"> }</span> |
| <span class="source-line-no">089</span><span id="line-89"></span> |
| <span class="source-line-no">090</span><span id="line-90"> public RetryConfig setTimeUnit(TimeUnit timeUnit) {</span> |
| <span class="source-line-no">091</span><span id="line-91"> this.timeUnit = timeUnit;</span> |
| <span class="source-line-no">092</span><span id="line-92"> return this;</span> |
| <span class="source-line-no">093</span><span id="line-93"> }</span> |
| <span class="source-line-no">094</span><span id="line-94"></span> |
| <span class="source-line-no">095</span><span id="line-95"> public RetryConfig setJitter(float jitter) {</span> |
| <span class="source-line-no">096</span><span id="line-96"> Preconditions.checkArgument(jitter >= 0.0f && jitter < 1.0f,</span> |
| <span class="source-line-no">097</span><span id="line-97"> "Invalid jitter: %s, should be in range [0.0, 1.0)", jitter);</span> |
| <span class="source-line-no">098</span><span id="line-98"> this.jitter = jitter;</span> |
| <span class="source-line-no">099</span><span id="line-99"> return this;</span> |
| <span class="source-line-no">100</span><span id="line-100"> }</span> |
| <span class="source-line-no">101</span><span id="line-101"></span> |
| <span class="source-line-no">102</span><span id="line-102"> public int getMaxAttempts() {</span> |
| <span class="source-line-no">103</span><span id="line-103"> return maxAttempts;</span> |
| <span class="source-line-no">104</span><span id="line-104"> }</span> |
| <span class="source-line-no">105</span><span id="line-105"></span> |
| <span class="source-line-no">106</span><span id="line-106"> public long getMaxSleepTime() {</span> |
| <span class="source-line-no">107</span><span id="line-107"> return maxSleepTime;</span> |
| <span class="source-line-no">108</span><span id="line-108"> }</span> |
| <span class="source-line-no">109</span><span id="line-109"></span> |
| <span class="source-line-no">110</span><span id="line-110"> public long getSleepInterval() {</span> |
| <span class="source-line-no">111</span><span id="line-111"> return sleepInterval;</span> |
| <span class="source-line-no">112</span><span id="line-112"> }</span> |
| <span class="source-line-no">113</span><span id="line-113"></span> |
| <span class="source-line-no">114</span><span id="line-114"> public TimeUnit getTimeUnit() {</span> |
| <span class="source-line-no">115</span><span id="line-115"> return timeUnit;</span> |
| <span class="source-line-no">116</span><span id="line-116"> }</span> |
| <span class="source-line-no">117</span><span id="line-117"></span> |
| <span class="source-line-no">118</span><span id="line-118"> public float getJitter() {</span> |
| <span class="source-line-no">119</span><span id="line-119"> return jitter;</span> |
| <span class="source-line-no">120</span><span id="line-120"> }</span> |
| <span class="source-line-no">121</span><span id="line-121"></span> |
| <span class="source-line-no">122</span><span id="line-122"> public BackoffPolicy getBackoffPolicy() {</span> |
| <span class="source-line-no">123</span><span id="line-123"> return backoffPolicy;</span> |
| <span class="source-line-no">124</span><span id="line-124"> }</span> |
| <span class="source-line-no">125</span><span id="line-125"> }</span> |
| <span class="source-line-no">126</span><span id="line-126"></span> |
| <span class="source-line-no">127</span><span id="line-127"> private static long addJitter(long interval, float jitter) {</span> |
| <span class="source-line-no">128</span><span id="line-128"> long jitterInterval = (long) (interval * ThreadLocalRandom.current().nextFloat() * jitter);</span> |
| <span class="source-line-no">129</span><span id="line-129"> return interval + jitterInterval;</span> |
| <span class="source-line-no">130</span><span id="line-130"> }</span> |
| <span class="source-line-no">131</span><span id="line-131"></span> |
| <span class="source-line-no">132</span><span id="line-132"> /**</span> |
| <span class="source-line-no">133</span><span id="line-133"> * Policy for calculating sleeping intervals between retry attempts</span> |
| <span class="source-line-no">134</span><span id="line-134"> */</span> |
| <span class="source-line-no">135</span><span id="line-135"> public static class BackoffPolicy {</span> |
| <span class="source-line-no">136</span><span id="line-136"> public long getBackoffTime(RetryConfig config, int attempts) {</span> |
| <span class="source-line-no">137</span><span id="line-137"> return addJitter(config.getSleepInterval(), config.getJitter());</span> |
| <span class="source-line-no">138</span><span id="line-138"> }</span> |
| <span class="source-line-no">139</span><span id="line-139"> }</span> |
| <span class="source-line-no">140</span><span id="line-140"></span> |
| <span class="source-line-no">141</span><span id="line-141"> public static class ExponentialBackoffPolicy extends BackoffPolicy {</span> |
| <span class="source-line-no">142</span><span id="line-142"> @Override</span> |
| <span class="source-line-no">143</span><span id="line-143"> public long getBackoffTime(RetryConfig config, int attempts) {</span> |
| <span class="source-line-no">144</span><span id="line-144"> long backoffTime = (long) (config.getSleepInterval() * Math.pow(2, attempts));</span> |
| <span class="source-line-no">145</span><span id="line-145"> return addJitter(backoffTime, config.getJitter());</span> |
| <span class="source-line-no">146</span><span id="line-146"> }</span> |
| <span class="source-line-no">147</span><span id="line-147"> }</span> |
| <span class="source-line-no">148</span><span id="line-148"></span> |
| <span class="source-line-no">149</span><span id="line-149"> public static class ExponentialBackoffPolicyWithLimit extends ExponentialBackoffPolicy {</span> |
| <span class="source-line-no">150</span><span id="line-150"> @Override</span> |
| <span class="source-line-no">151</span><span id="line-151"> public long getBackoffTime(RetryConfig config, int attempts) {</span> |
| <span class="source-line-no">152</span><span id="line-152"> long backoffTime = super.getBackoffTime(config, attempts);</span> |
| <span class="source-line-no">153</span><span id="line-153"> return config.getMaxSleepTime() > 0</span> |
| <span class="source-line-no">154</span><span id="line-154"> ? Math.min(backoffTime, config.getMaxSleepTime())</span> |
| <span class="source-line-no">155</span><span id="line-155"> : backoffTime;</span> |
| <span class="source-line-no">156</span><span id="line-156"> }</span> |
| <span class="source-line-no">157</span><span id="line-157"> }</span> |
| <span class="source-line-no">158</span><span id="line-158"></span> |
| <span class="source-line-no">159</span><span id="line-159"> private static final Logger LOG = LoggerFactory.getLogger(RetryCounter.class);</span> |
| <span class="source-line-no">160</span><span id="line-160"></span> |
| <span class="source-line-no">161</span><span id="line-161"> private RetryConfig retryConfig;</span> |
| <span class="source-line-no">162</span><span id="line-162"> private int attempts;</span> |
| <span class="source-line-no">163</span><span id="line-163"></span> |
| <span class="source-line-no">164</span><span id="line-164"> public RetryCounter(int maxAttempts, long sleepInterval, TimeUnit timeUnit) {</span> |
| <span class="source-line-no">165</span><span id="line-165"> this(new RetryConfig(maxAttempts, sleepInterval, -1, timeUnit, new ExponentialBackoffPolicy()));</span> |
| <span class="source-line-no">166</span><span id="line-166"> }</span> |
| <span class="source-line-no">167</span><span id="line-167"></span> |
| <span class="source-line-no">168</span><span id="line-168"> public RetryCounter(RetryConfig retryConfig) {</span> |
| <span class="source-line-no">169</span><span id="line-169"> this.attempts = 0;</span> |
| <span class="source-line-no">170</span><span id="line-170"> this.retryConfig = retryConfig;</span> |
| <span class="source-line-no">171</span><span id="line-171"> }</span> |
| <span class="source-line-no">172</span><span id="line-172"></span> |
| <span class="source-line-no">173</span><span id="line-173"> public int getMaxAttempts() {</span> |
| <span class="source-line-no">174</span><span id="line-174"> return retryConfig.getMaxAttempts();</span> |
| <span class="source-line-no">175</span><span id="line-175"> }</span> |
| <span class="source-line-no">176</span><span id="line-176"></span> |
| <span class="source-line-no">177</span><span id="line-177"> /**</span> |
| <span class="source-line-no">178</span><span id="line-178"> * Sleep for a back off time as supplied by the backoff policy, and increases the attempts</span> |
| <span class="source-line-no">179</span><span id="line-179"> */</span> |
| <span class="source-line-no">180</span><span id="line-180"> public void sleepUntilNextRetry() throws InterruptedException {</span> |
| <span class="source-line-no">181</span><span id="line-181"> int attempts = getAttemptTimes();</span> |
| <span class="source-line-no">182</span><span id="line-182"> long sleepTime = getBackoffTime();</span> |
| <span class="source-line-no">183</span><span id="line-183"> LOG.trace("Sleeping {} ms before retry #{}...", sleepTime, attempts);</span> |
| <span class="source-line-no">184</span><span id="line-184"> retryConfig.getTimeUnit().sleep(sleepTime);</span> |
| <span class="source-line-no">185</span><span id="line-185"> useRetry();</span> |
| <span class="source-line-no">186</span><span id="line-186"> }</span> |
| <span class="source-line-no">187</span><span id="line-187"></span> |
| <span class="source-line-no">188</span><span id="line-188"> public boolean shouldRetry() {</span> |
| <span class="source-line-no">189</span><span id="line-189"> return attempts < retryConfig.getMaxAttempts();</span> |
| <span class="source-line-no">190</span><span id="line-190"> }</span> |
| <span class="source-line-no">191</span><span id="line-191"></span> |
| <span class="source-line-no">192</span><span id="line-192"> public void useRetry() {</span> |
| <span class="source-line-no">193</span><span id="line-193"> attempts++;</span> |
| <span class="source-line-no">194</span><span id="line-194"> }</span> |
| <span class="source-line-no">195</span><span id="line-195"></span> |
| <span class="source-line-no">196</span><span id="line-196"> public boolean isRetry() {</span> |
| <span class="source-line-no">197</span><span id="line-197"> return attempts > 0;</span> |
| <span class="source-line-no">198</span><span id="line-198"> }</span> |
| <span class="source-line-no">199</span><span id="line-199"></span> |
| <span class="source-line-no">200</span><span id="line-200"> public int getAttemptTimes() {</span> |
| <span class="source-line-no">201</span><span id="line-201"> return attempts;</span> |
| <span class="source-line-no">202</span><span id="line-202"> }</span> |
| <span class="source-line-no">203</span><span id="line-203"></span> |
| <span class="source-line-no">204</span><span id="line-204"> public long getBackoffTime() {</span> |
| <span class="source-line-no">205</span><span id="line-205"> return this.retryConfig.backoffPolicy.getBackoffTime(this.retryConfig, getAttemptTimes());</span> |
| <span class="source-line-no">206</span><span id="line-206"> }</span> |
| <span class="source-line-no">207</span><span id="line-207"></span> |
| <span class="source-line-no">208</span><span id="line-208"> public long getBackoffTimeAndIncrementAttempts() {</span> |
| <span class="source-line-no">209</span><span id="line-209"> long backoffTime = getBackoffTime();</span> |
| <span class="source-line-no">210</span><span id="line-210"> useRetry();</span> |
| <span class="source-line-no">211</span><span id="line-211"> return backoffTime;</span> |
| <span class="source-line-no">212</span><span id="line-212"> }</span> |
| <span class="source-line-no">213</span><span id="line-213">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |