Google Git
Sign in
apache / hbase-site / d39145750fae8a2e1c598210014095b6c9793027 / . / devapidocs / src-html / org / apache / hadoop / hbase / client / ConnectionOverAsyncConnection.html
blob: b8558696b7ae3ea572b1fa9fb8a4f88d33bb1549 [file] [log] [blame]
<!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: ConnectionOverAsyncConnection">
<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.BlockingQueue;</span>
<span class="source-line-no">022</span><span id="line-22">import java.util.concurrent.ExecutorService;</span>
<span class="source-line-no">023</span><span id="line-23">import java.util.concurrent.LinkedBlockingQueue;</span>
<span class="source-line-no">024</span><span id="line-24">import java.util.concurrent.ThreadPoolExecutor;</span>
<span class="source-line-no">025</span><span id="line-25">import java.util.concurrent.TimeUnit;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.DoNotRetryIOException;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.HConstants;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.ServerName;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.TableName;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.log.HBaseMarkers;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.util.FutureUtils;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.util.IOExceptionSupplier;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">035</span><span id="line-35">import org.slf4j.Logger;</span>
<span class="source-line-no">036</span><span id="line-36">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">037</span><span id="line-37"></span>
<span class="source-line-no">038</span><span id="line-38">import org.apache.hbase.thirdparty.com.google.common.io.Closeables;</span>
<span class="source-line-no">039</span><span id="line-39">import org.apache.hbase.thirdparty.com.google.common.util.concurrent.ThreadFactoryBuilder;</span>
<span class="source-line-no">040</span><span id="line-40"></span>
<span class="source-line-no">041</span><span id="line-41">/**</span>
<span class="source-line-no">042</span><span id="line-42"> * The connection implementation based on {@link AsyncConnection}.</span>
<span class="source-line-no">043</span><span id="line-43"> */</span>
<span class="source-line-no">044</span><span id="line-44">@InterfaceAudience.Private</span>
<span class="source-line-no">045</span><span id="line-45">class ConnectionOverAsyncConnection implements Connection {</span>
<span class="source-line-no">046</span><span id="line-46"></span>
<span class="source-line-no">047</span><span id="line-47"> private static final Logger LOG = LoggerFactory.getLogger(ConnectionOverAsyncConnection.class);</span>
<span class="source-line-no">048</span><span id="line-48"></span>
<span class="source-line-no">049</span><span id="line-49"> private volatile boolean aborted = false;</span>
<span class="source-line-no">050</span><span id="line-50"></span>
<span class="source-line-no">051</span><span id="line-51"> // only used for executing coprocessor calls, as users may reference the methods in the</span>
<span class="source-line-no">052</span><span id="line-52"> // BlockingInterface of the protobuf stub so we have to execute the call in a separated thread...</span>
<span class="source-line-no">053</span><span id="line-53"> // Will be removed in 4.0.0 along with the deprecated coprocessor methods in Table and Admin</span>
<span class="source-line-no">054</span><span id="line-54"> // interface.</span>
<span class="source-line-no">055</span><span id="line-55"> private volatile ExecutorService batchPool = null;</span>
<span class="source-line-no">056</span><span id="line-56"></span>
<span class="source-line-no">057</span><span id="line-57"> private final AsyncConnectionImpl conn;</span>
<span class="source-line-no">058</span><span id="line-58"></span>
<span class="source-line-no">059</span><span id="line-59"> private final ConnectionConfiguration connConf;</span>
<span class="source-line-no">060</span><span id="line-60"></span>
<span class="source-line-no">061</span><span id="line-61"> ConnectionOverAsyncConnection(AsyncConnectionImpl conn) {</span>
<span class="source-line-no">062</span><span id="line-62"> this.conn = conn;</span>
<span class="source-line-no">063</span><span id="line-63"> this.connConf = new ConnectionConfiguration(conn.getConfiguration());</span>
<span class="source-line-no">064</span><span id="line-64"> }</span>
<span class="source-line-no">065</span><span id="line-65"></span>
<span class="source-line-no">066</span><span id="line-66"> @Override</span>
<span class="source-line-no">067</span><span id="line-67"> public void abort(String why, Throwable error) {</span>
<span class="source-line-no">068</span><span id="line-68"> if (error != null) {</span>
<span class="source-line-no">069</span><span id="line-69"> LOG.error(HBaseMarkers.FATAL, why, error);</span>
<span class="source-line-no">070</span><span id="line-70"> } else {</span>
<span class="source-line-no">071</span><span id="line-71"> LOG.error(HBaseMarkers.FATAL, why);</span>
<span class="source-line-no">072</span><span id="line-72"> }</span>
<span class="source-line-no">073</span><span id="line-73"> aborted = true;</span>
<span class="source-line-no">074</span><span id="line-74"> try {</span>
<span class="source-line-no">075</span><span id="line-75"> Closeables.close(this, true);</span>
<span class="source-line-no">076</span><span id="line-76"> } catch (IOException e) {</span>
<span class="source-line-no">077</span><span id="line-77"> throw new AssertionError(e);</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"></span>
<span class="source-line-no">081</span><span id="line-81"> @Override</span>
<span class="source-line-no">082</span><span id="line-82"> public boolean isAborted() {</span>
<span class="source-line-no">083</span><span id="line-83"> return aborted;</span>
<span class="source-line-no">084</span><span id="line-84"> }</span>
<span class="source-line-no">085</span><span id="line-85"></span>
<span class="source-line-no">086</span><span id="line-86"> @Override</span>
<span class="source-line-no">087</span><span id="line-87"> public Configuration getConfiguration() {</span>
<span class="source-line-no">088</span><span id="line-88"> return conn.getConfiguration();</span>
<span class="source-line-no">089</span><span id="line-89"> }</span>
<span class="source-line-no">090</span><span id="line-90"></span>
<span class="source-line-no">091</span><span id="line-91"> @Override</span>
<span class="source-line-no">092</span><span id="line-92"> public BufferedMutator getBufferedMutator(BufferedMutatorParams params) throws IOException {</span>
<span class="source-line-no">093</span><span id="line-93"> AsyncBufferedMutatorBuilder builder = conn.getBufferedMutatorBuilder(params.getTableName());</span>
<span class="source-line-no">094</span><span id="line-94"> if (params.getRpcTimeout() != BufferedMutatorParams.UNSET) {</span>
<span class="source-line-no">095</span><span id="line-95"> builder.setRpcTimeout(params.getRpcTimeout(), TimeUnit.MILLISECONDS);</span>
<span class="source-line-no">096</span><span id="line-96"> }</span>
<span class="source-line-no">097</span><span id="line-97"> if (params.getOperationTimeout() != BufferedMutatorParams.UNSET) {</span>
<span class="source-line-no">098</span><span id="line-98"> builder.setOperationTimeout(params.getOperationTimeout(), TimeUnit.MILLISECONDS);</span>
<span class="source-line-no">099</span><span id="line-99"> }</span>
<span class="source-line-no">100</span><span id="line-100"> if (params.getWriteBufferSize() != BufferedMutatorParams.UNSET) {</span>
<span class="source-line-no">101</span><span id="line-101"> builder.setWriteBufferSize(params.getWriteBufferSize());</span>
<span class="source-line-no">102</span><span id="line-102"> }</span>
<span class="source-line-no">103</span><span id="line-103"> if (params.getWriteBufferPeriodicFlushTimeoutMs() != BufferedMutatorParams.UNSET) {</span>
<span class="source-line-no">104</span><span id="line-104"> builder.setWriteBufferPeriodicFlush(params.getWriteBufferPeriodicFlushTimeoutMs(),</span>
<span class="source-line-no">105</span><span id="line-105"> TimeUnit.MILLISECONDS);</span>
<span class="source-line-no">106</span><span id="line-106"> }</span>
<span class="source-line-no">107</span><span id="line-107"> if (params.getMaxKeyValueSize() != BufferedMutatorParams.UNSET) {</span>
<span class="source-line-no">108</span><span id="line-108"> builder.setMaxKeyValueSize(params.getMaxKeyValueSize());</span>
<span class="source-line-no">109</span><span id="line-109"> }</span>
<span class="source-line-no">110</span><span id="line-110"> return new BufferedMutatorOverAsyncBufferedMutator(builder.build(), params.getListener());</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"> @Override</span>
<span class="source-line-no">114</span><span id="line-114"> public RegionLocator getRegionLocator(TableName tableName) throws IOException {</span>
<span class="source-line-no">115</span><span id="line-115"> return new RegionLocatorOverAsyncTableRegionLocator(conn.getRegionLocator(tableName));</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"> @Override</span>
<span class="source-line-no">119</span><span id="line-119"> public void clearRegionLocationCache() {</span>
<span class="source-line-no">120</span><span id="line-120"> conn.clearRegionLocationCache();</span>
<span class="source-line-no">121</span><span id="line-121"> }</span>
<span class="source-line-no">122</span><span id="line-122"></span>
<span class="source-line-no">123</span><span id="line-123"> @Override</span>
<span class="source-line-no">124</span><span id="line-124"> public Admin getAdmin() throws IOException {</span>
<span class="source-line-no">125</span><span id="line-125"> return new AdminOverAsyncAdmin(this, (RawAsyncHBaseAdmin) conn.getAdmin());</span>
<span class="source-line-no">126</span><span id="line-126"> }</span>
<span class="source-line-no">127</span><span id="line-127"></span>
<span class="source-line-no">128</span><span id="line-128"> @Override</span>
<span class="source-line-no">129</span><span id="line-129"> public void close() throws IOException {</span>
<span class="source-line-no">130</span><span id="line-130"> conn.close();</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"> // will be called from AsyncConnection, to avoid infinite loop as in the above method we will call</span>
<span class="source-line-no">134</span><span id="line-134"> // AsyncConnection.close.</span>
<span class="source-line-no">135</span><span id="line-135"> synchronized void closePool() {</span>
<span class="source-line-no">136</span><span id="line-136"> ExecutorService batchPool = this.batchPool;</span>
<span class="source-line-no">137</span><span id="line-137"> if (batchPool != null) {</span>
<span class="source-line-no">138</span><span id="line-138"> ConnectionUtils.shutdownPool(batchPool);</span>
<span class="source-line-no">139</span><span id="line-139"> this.batchPool = null;</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"></span>
<span class="source-line-no">143</span><span id="line-143"> @Override</span>
<span class="source-line-no">144</span><span id="line-144"> public boolean isClosed() {</span>
<span class="source-line-no">145</span><span id="line-145"> return conn.isClosed();</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"> // only used for executing coprocessor calls, as users may reference the methods in the</span>
<span class="source-line-no">149</span><span id="line-149"> // BlockingInterface of the protobuf stub so we have to execute the call in a separated thread...</span>
<span class="source-line-no">150</span><span id="line-150"> // Will be removed in 4.0.0 along with the deprecated coprocessor methods in Table and Admin</span>
<span class="source-line-no">151</span><span id="line-151"> // interface.</span>
<span class="source-line-no">152</span><span id="line-152"> private ThreadPoolExecutor createThreadPool() {</span>
<span class="source-line-no">153</span><span id="line-153"> Configuration conf = conn.getConfiguration();</span>
<span class="source-line-no">154</span><span id="line-154"> int threads = conf.getInt("hbase.hconnection.threads.max", 256);</span>
<span class="source-line-no">155</span><span id="line-155"> long keepAliveTime = conf.getLong("hbase.hconnection.threads.keepalivetime", 60);</span>
<span class="source-line-no">156</span><span id="line-156"> BlockingQueue&lt;Runnable&gt; workQueue =</span>
<span class="source-line-no">157</span><span id="line-157"> new LinkedBlockingQueue&lt;&gt;(threads * conf.getInt(HConstants.HBASE_CLIENT_MAX_TOTAL_TASKS,</span>
<span class="source-line-no">158</span><span id="line-158"> HConstants.DEFAULT_HBASE_CLIENT_MAX_TOTAL_TASKS));</span>
<span class="source-line-no">159</span><span id="line-159"> ThreadPoolExecutor tpe = new ThreadPoolExecutor(threads, threads, keepAliveTime,</span>
<span class="source-line-no">160</span><span id="line-160"> TimeUnit.SECONDS, workQueue,</span>
<span class="source-line-no">161</span><span id="line-161"> new ThreadFactoryBuilder().setDaemon(true).setNameFormat(toString() + "-shared-%d").build());</span>
<span class="source-line-no">162</span><span id="line-162"> tpe.allowCoreThreadTimeOut(true);</span>
<span class="source-line-no">163</span><span id="line-163"> return tpe;</span>
<span class="source-line-no">164</span><span id="line-164"> }</span>
<span class="source-line-no">165</span><span id="line-165"></span>
<span class="source-line-no">166</span><span id="line-166"> // only used for executing coprocessor calls, as users may reference the methods in the</span>
<span class="source-line-no">167</span><span id="line-167"> // BlockingInterface of the protobuf stub so we have to execute the call in a separated thread...</span>
<span class="source-line-no">168</span><span id="line-168"> // Will be removed in 4.0.0 along with the deprecated coprocessor methods in Table and Admin</span>
<span class="source-line-no">169</span><span id="line-169"> // interface.</span>
<span class="source-line-no">170</span><span id="line-170"> private ExecutorService getBatchPool() throws IOException {</span>
<span class="source-line-no">171</span><span id="line-171"> if (batchPool == null) {</span>
<span class="source-line-no">172</span><span id="line-172"> synchronized (this) {</span>
<span class="source-line-no">173</span><span id="line-173"> if (isClosed()) {</span>
<span class="source-line-no">174</span><span id="line-174"> throw new DoNotRetryIOException("Connection is closed");</span>
<span class="source-line-no">175</span><span id="line-175"> }</span>
<span class="source-line-no">176</span><span id="line-176"> if (batchPool == null) {</span>
<span class="source-line-no">177</span><span id="line-177"> this.batchPool = createThreadPool();</span>
<span class="source-line-no">178</span><span id="line-178"> }</span>
<span class="source-line-no">179</span><span id="line-179"> }</span>
<span class="source-line-no">180</span><span id="line-180"> }</span>
<span class="source-line-no">181</span><span id="line-181"> return this.batchPool;</span>
<span class="source-line-no">182</span><span id="line-182"> }</span>
<span class="source-line-no">183</span><span id="line-183"></span>
<span class="source-line-no">184</span><span id="line-184"> @Override</span>
<span class="source-line-no">185</span><span id="line-185"> public TableBuilder getTableBuilder(TableName tableName, ExecutorService pool) {</span>
<span class="source-line-no">186</span><span id="line-186"> return new TableBuilderBase(tableName, connConf) {</span>
<span class="source-line-no">187</span><span id="line-187"></span>
<span class="source-line-no">188</span><span id="line-188"> @Override</span>
<span class="source-line-no">189</span><span id="line-189"> public Table build() {</span>
<span class="source-line-no">190</span><span id="line-190"> IOExceptionSupplier&lt;ExecutorService&gt; poolSupplier =</span>
<span class="source-line-no">191</span><span id="line-191"> pool != null ? () -&gt; pool : ConnectionOverAsyncConnection.this::getBatchPool;</span>
<span class="source-line-no">192</span><span id="line-192"> AsyncTableBuilder&lt;AdvancedScanResultConsumer&gt; tableBuilder =</span>
<span class="source-line-no">193</span><span id="line-193"> conn.getTableBuilder(tableName).setRpcTimeout(rpcTimeout, TimeUnit.MILLISECONDS)</span>
<span class="source-line-no">194</span><span id="line-194"> .setReadRpcTimeout(readRpcTimeout, TimeUnit.MILLISECONDS)</span>
<span class="source-line-no">195</span><span id="line-195"> .setWriteRpcTimeout(writeRpcTimeout, TimeUnit.MILLISECONDS)</span>
<span class="source-line-no">196</span><span id="line-196"> .setOperationTimeout(operationTimeout, TimeUnit.MILLISECONDS);</span>
<span class="source-line-no">197</span><span id="line-197"> requestAttributes.forEach(tableBuilder::setRequestAttribute);</span>
<span class="source-line-no">198</span><span id="line-198"> return new TableOverAsyncTable(conn, tableBuilder.build(), poolSupplier);</span>
<span class="source-line-no">199</span><span id="line-199"> }</span>
<span class="source-line-no">200</span><span id="line-200"> };</span>
<span class="source-line-no">201</span><span id="line-201"> }</span>
<span class="source-line-no">202</span><span id="line-202"></span>
<span class="source-line-no">203</span><span id="line-203"> @Override</span>
<span class="source-line-no">204</span><span id="line-204"> public AsyncConnection toAsyncConnection() {</span>
<span class="source-line-no">205</span><span id="line-205"> return conn;</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"> @Override</span>
<span class="source-line-no">209</span><span id="line-209"> public String getClusterId() {</span>
<span class="source-line-no">210</span><span id="line-210"> return conn.getClusterId();</span>
<span class="source-line-no">211</span><span id="line-211"> }</span>
<span class="source-line-no">212</span><span id="line-212"></span>
<span class="source-line-no">213</span><span id="line-213"> @Override</span>
<span class="source-line-no">214</span><span id="line-214"> public Hbck getHbck() throws IOException {</span>
<span class="source-line-no">215</span><span id="line-215"> return FutureUtils.get(conn.getHbck());</span>
<span class="source-line-no">216</span><span id="line-216"> }</span>
<span class="source-line-no">217</span><span id="line-217"></span>
<span class="source-line-no">218</span><span id="line-218"> @Override</span>
<span class="source-line-no">219</span><span id="line-219"> public Hbck getHbck(ServerName masterServer) throws IOException {</span>
<span class="source-line-no">220</span><span id="line-220"> return conn.getHbck(masterServer);</span>
<span class="source-line-no">221</span><span id="line-221"> }</span>
<span class="source-line-no">222</span><span id="line-222"></span>
<span class="source-line-no">223</span><span id="line-223"> /**</span>
<span class="source-line-no">224</span><span id="line-224"> * An identifier that will remain the same for a given connection.</span>
<span class="source-line-no">225</span><span id="line-225"> */</span>
<span class="source-line-no">226</span><span id="line-226"> @Override</span>
<span class="source-line-no">227</span><span id="line-227"> public String toString() {</span>
<span class="source-line-no">228</span><span id="line-228"> return "connection-over-async-connection-0x" + Integer.toHexString(hashCode());</span>
<span class="source-line-no">229</span><span id="line-229"> }</span>
<span class="source-line-no">230</span><span id="line-230">}</span>
</pre>
</div>
</main>
</body>
</html>