| <!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.client, class: RegistryEndpointsRefresher, interface: Refresher"> |
| <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.client;</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.io.IOException;</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.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.slf4j.Logger;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">027</span><span id="line-27"></span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hbase.thirdparty.com.google.common.base.Preconditions;</span> |
| <span class="source-line-no">029</span><span id="line-29"></span> |
| <span class="source-line-no">030</span><span id="line-30">/**</span> |
| <span class="source-line-no">031</span><span id="line-31"> * Thread safe utility that keeps registry end points used by {@link ConnectionRegistry} up to date.</span> |
| <span class="source-line-no">032</span><span id="line-32"> * By default the refresh happens periodically (configured via {@code intervalSecsConfigName}). The</span> |
| <span class="source-line-no">033</span><span id="line-33"> * refresh can also be triggered on demand via {@link #refreshNow()}. To prevent a flood of</span> |
| <span class="source-line-no">034</span><span id="line-34"> * on-demand refreshes we expect that any attempts two should be spaced at least</span> |
| <span class="source-line-no">035</span><span id="line-35"> * {@code minIntervalSecsConfigName} seconds apart.</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">final class RegistryEndpointsRefresher {</span> |
| <span class="source-line-no">039</span><span id="line-39"></span> |
| <span class="source-line-no">040</span><span id="line-40"> private static final Logger LOG = LoggerFactory.getLogger(RegistryEndpointsRefresher.class);</span> |
| <span class="source-line-no">041</span><span id="line-41"></span> |
| <span class="source-line-no">042</span><span id="line-42"> private static final int PERIODIC_REFRESH_INTERVAL_SECS_DEFAULT = 300;</span> |
| <span class="source-line-no">043</span><span id="line-43"></span> |
| <span class="source-line-no">044</span><span id="line-44"> private static final int MIN_SECS_BETWEEN_REFRESHES_DEFAULT = 60;</span> |
| <span class="source-line-no">045</span><span id="line-45"></span> |
| <span class="source-line-no">046</span><span id="line-46"> private final Thread thread;</span> |
| <span class="source-line-no">047</span><span id="line-47"> private final Refresher refresher;</span> |
| <span class="source-line-no">048</span><span id="line-48"> private final long initialDelayMs;</span> |
| <span class="source-line-no">049</span><span id="line-49"> private final long periodicRefreshMs;</span> |
| <span class="source-line-no">050</span><span id="line-50"> private final long minTimeBetweenRefreshesMs;</span> |
| <span class="source-line-no">051</span><span id="line-51"></span> |
| <span class="source-line-no">052</span><span id="line-52"> private boolean refreshNow = false;</span> |
| <span class="source-line-no">053</span><span id="line-53"> private boolean stopped = false;</span> |
| <span class="source-line-no">054</span><span id="line-54"></span> |
| <span class="source-line-no">055</span><span id="line-55"> synchronized void stop() {</span> |
| <span class="source-line-no">056</span><span id="line-56"> stopped = true;</span> |
| <span class="source-line-no">057</span><span id="line-57"> notifyAll();</span> |
| <span class="source-line-no">058</span><span id="line-58"> }</span> |
| <span class="source-line-no">059</span><span id="line-59"></span> |
| <span class="source-line-no">060</span><span id="line-60"> private long getRefreshIntervalMs(boolean firstRefresh) {</span> |
| <span class="source-line-no">061</span><span id="line-61"> if (refreshNow) {</span> |
| <span class="source-line-no">062</span><span id="line-62"> return minTimeBetweenRefreshesMs;</span> |
| <span class="source-line-no">063</span><span id="line-63"> }</span> |
| <span class="source-line-no">064</span><span id="line-64"> if (firstRefresh) {</span> |
| <span class="source-line-no">065</span><span id="line-65"> return initialDelayMs;</span> |
| <span class="source-line-no">066</span><span id="line-66"> }</span> |
| <span class="source-line-no">067</span><span id="line-67"> return periodicRefreshMs;</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"> // The main loop for the refresh thread.</span> |
| <span class="source-line-no">071</span><span id="line-71"> private void mainLoop() {</span> |
| <span class="source-line-no">072</span><span id="line-72"> long lastRefreshTime = EnvironmentEdgeManager.currentTime();</span> |
| <span class="source-line-no">073</span><span id="line-73"> boolean firstRefresh = true;</span> |
| <span class="source-line-no">074</span><span id="line-74"> for (;;) {</span> |
| <span class="source-line-no">075</span><span id="line-75"> synchronized (this) {</span> |
| <span class="source-line-no">076</span><span id="line-76"> for (;;) {</span> |
| <span class="source-line-no">077</span><span id="line-77"> if (stopped) {</span> |
| <span class="source-line-no">078</span><span id="line-78"> LOG.info("Registry end points refresher loop exited.");</span> |
| <span class="source-line-no">079</span><span id="line-79"> return;</span> |
| <span class="source-line-no">080</span><span id="line-80"> }</span> |
| <span class="source-line-no">081</span><span id="line-81"> // if refreshNow is true, then we will wait until minTimeBetweenRefreshesMs elapsed,</span> |
| <span class="source-line-no">082</span><span id="line-82"> // otherwise wait until periodicRefreshMs elapsed</span> |
| <span class="source-line-no">083</span><span id="line-83"> long waitTime = getRefreshIntervalMs(firstRefresh)</span> |
| <span class="source-line-no">084</span><span id="line-84"> - (EnvironmentEdgeManager.currentTime() - lastRefreshTime);</span> |
| <span class="source-line-no">085</span><span id="line-85"> if (waitTime <= 0) {</span> |
| <span class="source-line-no">086</span><span id="line-86"> // we are going to refresh, reset this flag</span> |
| <span class="source-line-no">087</span><span id="line-87"> firstRefresh = false;</span> |
| <span class="source-line-no">088</span><span id="line-88"> refreshNow = false;</span> |
| <span class="source-line-no">089</span><span id="line-89"> break;</span> |
| <span class="source-line-no">090</span><span id="line-90"> }</span> |
| <span class="source-line-no">091</span><span id="line-91"> try {</span> |
| <span class="source-line-no">092</span><span id="line-92"> wait(waitTime);</span> |
| <span class="source-line-no">093</span><span id="line-93"> } catch (InterruptedException e) {</span> |
| <span class="source-line-no">094</span><span id="line-94"> LOG.warn("Interrupted during wait", e);</span> |
| <span class="source-line-no">095</span><span id="line-95"> Thread.currentThread().interrupt();</span> |
| <span class="source-line-no">096</span><span id="line-96"> continue;</span> |
| <span class="source-line-no">097</span><span id="line-97"> }</span> |
| <span class="source-line-no">098</span><span id="line-98"> }</span> |
| <span class="source-line-no">099</span><span id="line-99"> }</span> |
| <span class="source-line-no">100</span><span id="line-100"> LOG.debug("Attempting to refresh registry end points");</span> |
| <span class="source-line-no">101</span><span id="line-101"> try {</span> |
| <span class="source-line-no">102</span><span id="line-102"> refresher.refresh();</span> |
| <span class="source-line-no">103</span><span id="line-103"> } catch (IOException e) {</span> |
| <span class="source-line-no">104</span><span id="line-104"> LOG.warn("Error refresh registry end points", e);</span> |
| <span class="source-line-no">105</span><span id="line-105"> }</span> |
| <span class="source-line-no">106</span><span id="line-106"> // We do not think it is a big deal to fail one time, so no matter what is refresh result, we</span> |
| <span class="source-line-no">107</span><span id="line-107"> // just update this refresh time and wait for the next round. If later this becomes critical,</span> |
| <span class="source-line-no">108</span><span id="line-108"> // could change to only update this value when we have done a successful refreshing.</span> |
| <span class="source-line-no">109</span><span id="line-109"> lastRefreshTime = EnvironmentEdgeManager.currentTime();</span> |
| <span class="source-line-no">110</span><span id="line-110"> LOG.debug("Finished refreshing registry end points");</span> |
| <span class="source-line-no">111</span><span id="line-111"> }</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"> @FunctionalInterface</span> |
| <span class="source-line-no">115</span><span id="line-115"> public interface Refresher {</span> |
| <span class="source-line-no">116</span><span id="line-116"></span> |
| <span class="source-line-no">117</span><span id="line-117"> void refresh() throws IOException;</span> |
| <span class="source-line-no">118</span><span id="line-118"> }</span> |
| <span class="source-line-no">119</span><span id="line-119"></span> |
| <span class="source-line-no">120</span><span id="line-120"> private RegistryEndpointsRefresher(long initialDelayMs, long periodicRefreshMs,</span> |
| <span class="source-line-no">121</span><span id="line-121"> long minTimeBetweenRefreshesMs, Refresher refresher) {</span> |
| <span class="source-line-no">122</span><span id="line-122"> this.initialDelayMs = initialDelayMs;</span> |
| <span class="source-line-no">123</span><span id="line-123"> this.periodicRefreshMs = periodicRefreshMs;</span> |
| <span class="source-line-no">124</span><span id="line-124"> this.minTimeBetweenRefreshesMs = minTimeBetweenRefreshesMs;</span> |
| <span class="source-line-no">125</span><span id="line-125"> this.refresher = refresher;</span> |
| <span class="source-line-no">126</span><span id="line-126"> thread = new Thread(this::mainLoop);</span> |
| <span class="source-line-no">127</span><span id="line-127"> thread.setName("Registry-endpoints-refresh-end-points");</span> |
| <span class="source-line-no">128</span><span id="line-128"> thread.setDaemon(true);</span> |
| <span class="source-line-no">129</span><span id="line-129"> thread.start();</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"> * Notifies the refresher thread to refresh the configuration. This does not guarantee a refresh.</span> |
| <span class="source-line-no">134</span><span id="line-134"> * See class comment for details.</span> |
| <span class="source-line-no">135</span><span id="line-135"> */</span> |
| <span class="source-line-no">136</span><span id="line-136"> synchronized void refreshNow() {</span> |
| <span class="source-line-no">137</span><span id="line-137"> refreshNow = true;</span> |
| <span class="source-line-no">138</span><span id="line-138"> notifyAll();</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"> /**</span> |
| <span class="source-line-no">142</span><span id="line-142"> * Create a {@link RegistryEndpointsRefresher}. If the interval secs configured via</span> |
| <span class="source-line-no">143</span><span id="line-143"> * {@code intervalSecsConfigName} is less than zero, will return null here, which means disable</span> |
| <span class="source-line-no">144</span><span id="line-144"> * refreshing of endpoints.</span> |
| <span class="source-line-no">145</span><span id="line-145"> */</span> |
| <span class="source-line-no">146</span><span id="line-146"> static RegistryEndpointsRefresher create(Configuration conf, String initialDelaySecsConfigName,</span> |
| <span class="source-line-no">147</span><span id="line-147"> String intervalSecsConfigName, String minIntervalSecsConfigName, Refresher refresher) {</span> |
| <span class="source-line-no">148</span><span id="line-148"> long periodicRefreshMs = TimeUnit.SECONDS</span> |
| <span class="source-line-no">149</span><span id="line-149"> .toMillis(conf.getLong(intervalSecsConfigName, PERIODIC_REFRESH_INTERVAL_SECS_DEFAULT));</span> |
| <span class="source-line-no">150</span><span id="line-150"> if (periodicRefreshMs <= 0) {</span> |
| <span class="source-line-no">151</span><span id="line-151"> return null;</span> |
| <span class="source-line-no">152</span><span id="line-152"> }</span> |
| <span class="source-line-no">153</span><span id="line-153"> long initialDelayMs = Math.max(1,</span> |
| <span class="source-line-no">154</span><span id="line-154"> TimeUnit.SECONDS.toMillis(conf.getLong(initialDelaySecsConfigName, periodicRefreshMs / 10)));</span> |
| <span class="source-line-no">155</span><span id="line-155"> long minTimeBetweenRefreshesMs = TimeUnit.SECONDS</span> |
| <span class="source-line-no">156</span><span id="line-156"> .toMillis(conf.getLong(minIntervalSecsConfigName, MIN_SECS_BETWEEN_REFRESHES_DEFAULT));</span> |
| <span class="source-line-no">157</span><span id="line-157"> Preconditions.checkArgument(minTimeBetweenRefreshesMs <= periodicRefreshMs);</span> |
| <span class="source-line-no">158</span><span id="line-158"> return new RegistryEndpointsRefresher(initialDelayMs, periodicRefreshMs,</span> |
| <span class="source-line-no">159</span><span id="line-159"> minTimeBetweenRefreshesMs, refresher);</span> |
| <span class="source-line-no">160</span><span id="line-160"> }</span> |
| <span class="source-line-no">161</span><span id="line-161">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
