blob: 5184519dd1251646e71c7f1aed635d7c8889c7d5 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a>
<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a>
<span class="sourceLineNo">017</span> */<a name="line.17"></a>
<span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.regionserver;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import static org.junit.Assert.assertEquals;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import static org.junit.Assert.assertTrue;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import static org.junit.Assert.fail;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.io.IOException;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.ArrayList;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.List;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.concurrent.Callable;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.commons.lang3.exception.ExceptionUtils;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.hadoop.conf.Configuration;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.fs.FileSystem;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.fs.Path;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.Cell;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.CellComparator;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.CellComparatorImpl;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.CellUtil;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.HBaseClassTestRule;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.HBaseTestingUtility;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.HConstants;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.HTestConst;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.KeyValue;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.TableName;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.client.AdvancedScanResultConsumer;<a name="line.42"></a>
<span class="sourceLineNo">043</span>import org.apache.hadoop.hbase.client.AsyncConnection;<a name="line.43"></a>
<span class="sourceLineNo">044</span>import org.apache.hadoop.hbase.client.AsyncTable;<a name="line.44"></a>
<span class="sourceLineNo">045</span>import org.apache.hadoop.hbase.client.ConnectionFactory;<a name="line.45"></a>
<span class="sourceLineNo">046</span>import org.apache.hadoop.hbase.client.Put;<a name="line.46"></a>
<span class="sourceLineNo">047</span>import org.apache.hadoop.hbase.client.RegionInfo;<a name="line.47"></a>
<span class="sourceLineNo">048</span>import org.apache.hadoop.hbase.client.Result;<a name="line.48"></a>
<span class="sourceLineNo">049</span>import org.apache.hadoop.hbase.client.ResultScanner;<a name="line.49"></a>
<span class="sourceLineNo">050</span>import org.apache.hadoop.hbase.client.Scan;<a name="line.50"></a>
<span class="sourceLineNo">051</span>import org.apache.hadoop.hbase.client.ScanPerNextResultScanner;<a name="line.51"></a>
<span class="sourceLineNo">052</span>import org.apache.hadoop.hbase.client.Table;<a name="line.52"></a>
<span class="sourceLineNo">053</span>import org.apache.hadoop.hbase.client.TableDescriptor;<a name="line.53"></a>
<span class="sourceLineNo">054</span>import org.apache.hadoop.hbase.filter.Filter;<a name="line.54"></a>
<span class="sourceLineNo">055</span>import org.apache.hadoop.hbase.filter.FilterBase;<a name="line.55"></a>
<span class="sourceLineNo">056</span>import org.apache.hadoop.hbase.testclassification.LargeTests;<a name="line.56"></a>
<span class="sourceLineNo">057</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.57"></a>
<span class="sourceLineNo">058</span>import org.apache.hadoop.hbase.util.Threads;<a name="line.58"></a>
<span class="sourceLineNo">059</span>import org.apache.hadoop.hbase.wal.WAL;<a name="line.59"></a>
<span class="sourceLineNo">060</span>import org.junit.After;<a name="line.60"></a>
<span class="sourceLineNo">061</span>import org.junit.AfterClass;<a name="line.61"></a>
<span class="sourceLineNo">062</span>import org.junit.Before;<a name="line.62"></a>
<span class="sourceLineNo">063</span>import org.junit.BeforeClass;<a name="line.63"></a>
<span class="sourceLineNo">064</span>import org.junit.ClassRule;<a name="line.64"></a>
<span class="sourceLineNo">065</span>import org.junit.Test;<a name="line.65"></a>
<span class="sourceLineNo">066</span>import org.junit.experimental.categories.Category;<a name="line.66"></a>
<span class="sourceLineNo">067</span><a name="line.67"></a>
<span class="sourceLineNo">068</span>import org.apache.hbase.thirdparty.com.google.common.io.Closeables;<a name="line.68"></a>
<span class="sourceLineNo">069</span>import org.apache.hbase.thirdparty.com.google.protobuf.RpcController;<a name="line.69"></a>
<span class="sourceLineNo">070</span>import org.apache.hbase.thirdparty.com.google.protobuf.ServiceException;<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ScanRequest;<a name="line.72"></a>
<span class="sourceLineNo">073</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ScanResponse;<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span>/**<a name="line.75"></a>
<span class="sourceLineNo">076</span> * Here we test to make sure that scans return the expected Results when the server is sending the<a name="line.76"></a>
<span class="sourceLineNo">077</span> * Client heartbeat messages. Heartbeat messages are essentially keep-alive messages (they prevent<a name="line.77"></a>
<span class="sourceLineNo">078</span> * the scanner on the client side from timing out). A heartbeat message is sent from the server to<a name="line.78"></a>
<span class="sourceLineNo">079</span> * the client when the server has exceeded the time limit during the processing of the scan. When<a name="line.79"></a>
<span class="sourceLineNo">080</span> * the time limit is reached, the server will return to the Client whatever Results it has<a name="line.80"></a>
<span class="sourceLineNo">081</span> * accumulated (potentially empty).<a name="line.81"></a>
<span class="sourceLineNo">082</span> */<a name="line.82"></a>
<span class="sourceLineNo">083</span>@Category(LargeTests.class)<a name="line.83"></a>
<span class="sourceLineNo">084</span>public class TestScannerHeartbeatMessages {<a name="line.84"></a>
<span class="sourceLineNo">085</span><a name="line.85"></a>
<span class="sourceLineNo">086</span> @ClassRule<a name="line.86"></a>
<span class="sourceLineNo">087</span> public static final HBaseClassTestRule CLASS_RULE =<a name="line.87"></a>
<span class="sourceLineNo">088</span> HBaseClassTestRule.forClass(TestScannerHeartbeatMessages.class);<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span> private final static HBaseTestingUtility TEST_UTIL = new HBaseTestingUtility();<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span> private static AsyncConnection CONN;<a name="line.92"></a>
<span class="sourceLineNo">093</span><a name="line.93"></a>
<span class="sourceLineNo">094</span> /**<a name="line.94"></a>
<span class="sourceLineNo">095</span> * Table configuration<a name="line.95"></a>
<span class="sourceLineNo">096</span> */<a name="line.96"></a>
<span class="sourceLineNo">097</span> private static TableName TABLE_NAME = TableName.valueOf("testScannerHeartbeatMessagesTable");<a name="line.97"></a>
<span class="sourceLineNo">098</span><a name="line.98"></a>
<span class="sourceLineNo">099</span> private static int NUM_ROWS = 5;<a name="line.99"></a>
<span class="sourceLineNo">100</span> private static byte[] ROW = Bytes.toBytes("testRow");<a name="line.100"></a>
<span class="sourceLineNo">101</span> private static byte[][] ROWS = HTestConst.makeNAscii(ROW, NUM_ROWS);<a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span> private static int NUM_FAMILIES = 4;<a name="line.103"></a>
<span class="sourceLineNo">104</span> private static byte[] FAMILY = Bytes.toBytes("testFamily");<a name="line.104"></a>
<span class="sourceLineNo">105</span> private static byte[][] FAMILIES = HTestConst.makeNAscii(FAMILY, NUM_FAMILIES);<a name="line.105"></a>
<span class="sourceLineNo">106</span><a name="line.106"></a>
<span class="sourceLineNo">107</span> private static int NUM_QUALIFIERS = 3;<a name="line.107"></a>
<span class="sourceLineNo">108</span> private static byte[] QUALIFIER = Bytes.toBytes("testQualifier");<a name="line.108"></a>
<span class="sourceLineNo">109</span> private static byte[][] QUALIFIERS = HTestConst.makeNAscii(QUALIFIER, NUM_QUALIFIERS);<a name="line.109"></a>
<span class="sourceLineNo">110</span><a name="line.110"></a>
<span class="sourceLineNo">111</span> private static int VALUE_SIZE = 128;<a name="line.111"></a>
<span class="sourceLineNo">112</span> private static byte[] VALUE = Bytes.createMaxByteArray(VALUE_SIZE);<a name="line.112"></a>
<span class="sourceLineNo">113</span><a name="line.113"></a>
<span class="sourceLineNo">114</span> // The time limit should be based on the rpc timeout at client, or the client will regards<a name="line.114"></a>
<span class="sourceLineNo">115</span> // the request as timeout before server return a heartbeat.<a name="line.115"></a>
<span class="sourceLineNo">116</span> private static int SERVER_TIMEOUT = 60000;<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span> // Time, in milliseconds, that the client will wait for a response from the server before timing<a name="line.118"></a>
<span class="sourceLineNo">119</span> // out. This value is used server side to determine when it is necessary to send a heartbeat<a name="line.119"></a>
<span class="sourceLineNo">120</span> // message to the client. Time limit will be 500 ms.<a name="line.120"></a>
<span class="sourceLineNo">121</span> private static int CLIENT_TIMEOUT = 1000;<a name="line.121"></a>
<span class="sourceLineNo">122</span><a name="line.122"></a>
<span class="sourceLineNo">123</span> // In this test, we sleep after reading each row. So we should make sure after we get some number<a name="line.123"></a>
<span class="sourceLineNo">124</span> // of rows and sleep same times we must reach time limit, and do not timeout after next sleeping.<a name="line.124"></a>
<span class="sourceLineNo">125</span> private static int DEFAULT_ROW_SLEEP_TIME = 300;<a name="line.125"></a>
<span class="sourceLineNo">126</span><a name="line.126"></a>
<span class="sourceLineNo">127</span> // Similar with row sleep time.<a name="line.127"></a>
<span class="sourceLineNo">128</span> private static int DEFAULT_CF_SLEEP_TIME = 300;<a name="line.128"></a>
<span class="sourceLineNo">129</span><a name="line.129"></a>
<span class="sourceLineNo">130</span> @BeforeClass<a name="line.130"></a>
<span class="sourceLineNo">131</span> public static void setUpBeforeClass() throws Exception {<a name="line.131"></a>
<span class="sourceLineNo">132</span> Configuration conf = TEST_UTIL.getConfiguration();<a name="line.132"></a>
<span class="sourceLineNo">133</span><a name="line.133"></a>
<span class="sourceLineNo">134</span> conf.setStrings(HConstants.REGION_IMPL, HeartbeatHRegion.class.getName());<a name="line.134"></a>
<span class="sourceLineNo">135</span> conf.setStrings(HConstants.REGION_SERVER_IMPL, HeartbeatHRegionServer.class.getName());<a name="line.135"></a>
<span class="sourceLineNo">136</span> conf.setInt(HConstants.HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD, SERVER_TIMEOUT);<a name="line.136"></a>
<span class="sourceLineNo">137</span> conf.setInt(HConstants.HBASE_RPC_TIMEOUT_KEY, SERVER_TIMEOUT);<a name="line.137"></a>
<span class="sourceLineNo">138</span> conf.setInt(HConstants.HBASE_CLIENT_PAUSE, 1);<a name="line.138"></a>
<span class="sourceLineNo">139</span><a name="line.139"></a>
<span class="sourceLineNo">140</span> // Check the timeout condition after every cell<a name="line.140"></a>
<span class="sourceLineNo">141</span> conf.setLong(StoreScanner.HBASE_CELLS_SCANNED_PER_HEARTBEAT_CHECK, 1);<a name="line.141"></a>
<span class="sourceLineNo">142</span> TEST_UTIL.startMiniCluster(1);<a name="line.142"></a>
<span class="sourceLineNo">143</span><a name="line.143"></a>
<span class="sourceLineNo">144</span> createTestTable(TABLE_NAME, ROWS, FAMILIES, QUALIFIERS, VALUE);<a name="line.144"></a>
<span class="sourceLineNo">145</span><a name="line.145"></a>
<span class="sourceLineNo">146</span> Configuration newConf = new Configuration(conf);<a name="line.146"></a>
<span class="sourceLineNo">147</span> newConf.setInt(HConstants.HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD, CLIENT_TIMEOUT);<a name="line.147"></a>
<span class="sourceLineNo">148</span> newConf.setInt(HConstants.HBASE_RPC_TIMEOUT_KEY, CLIENT_TIMEOUT);<a name="line.148"></a>
<span class="sourceLineNo">149</span> CONN = ConnectionFactory.createAsyncConnection(newConf).get();<a name="line.149"></a>
<span class="sourceLineNo">150</span> }<a name="line.150"></a>
<span class="sourceLineNo">151</span><a name="line.151"></a>
<span class="sourceLineNo">152</span> static void createTestTable(TableName name, byte[][] rows, byte[][] families, byte[][] qualifiers,<a name="line.152"></a>
<span class="sourceLineNo">153</span> byte[] cellValue) throws IOException {<a name="line.153"></a>
<span class="sourceLineNo">154</span> Table ht = TEST_UTIL.createTable(name, families);<a name="line.154"></a>
<span class="sourceLineNo">155</span> List&lt;Put&gt; puts = createPuts(rows, families, qualifiers, cellValue);<a name="line.155"></a>
<span class="sourceLineNo">156</span> ht.put(puts);<a name="line.156"></a>
<span class="sourceLineNo">157</span> }<a name="line.157"></a>
<span class="sourceLineNo">158</span><a name="line.158"></a>
<span class="sourceLineNo">159</span> /**<a name="line.159"></a>
<span class="sourceLineNo">160</span> * Make puts to put the input value into each combination of row, family, and qualifier<a name="line.160"></a>
<span class="sourceLineNo">161</span> */<a name="line.161"></a>
<span class="sourceLineNo">162</span> static ArrayList&lt;Put&gt; createPuts(byte[][] rows, byte[][] families, byte[][] qualifiers,<a name="line.162"></a>
<span class="sourceLineNo">163</span> byte[] value) throws IOException {<a name="line.163"></a>
<span class="sourceLineNo">164</span> Put put;<a name="line.164"></a>
<span class="sourceLineNo">165</span> ArrayList&lt;Put&gt; puts = new ArrayList&lt;&gt;();<a name="line.165"></a>
<span class="sourceLineNo">166</span><a name="line.166"></a>
<span class="sourceLineNo">167</span> for (int row = 0; row &lt; rows.length; row++) {<a name="line.167"></a>
<span class="sourceLineNo">168</span> put = new Put(rows[row]);<a name="line.168"></a>
<span class="sourceLineNo">169</span> for (int fam = 0; fam &lt; families.length; fam++) {<a name="line.169"></a>
<span class="sourceLineNo">170</span> for (int qual = 0; qual &lt; qualifiers.length; qual++) {<a name="line.170"></a>
<span class="sourceLineNo">171</span> KeyValue kv = new KeyValue(rows[row], families[fam], qualifiers[qual], qual, value);<a name="line.171"></a>
<span class="sourceLineNo">172</span> put.add(kv);<a name="line.172"></a>
<span class="sourceLineNo">173</span> }<a name="line.173"></a>
<span class="sourceLineNo">174</span> }<a name="line.174"></a>
<span class="sourceLineNo">175</span> puts.add(put);<a name="line.175"></a>
<span class="sourceLineNo">176</span> }<a name="line.176"></a>
<span class="sourceLineNo">177</span><a name="line.177"></a>
<span class="sourceLineNo">178</span> return puts;<a name="line.178"></a>
<span class="sourceLineNo">179</span> }<a name="line.179"></a>
<span class="sourceLineNo">180</span><a name="line.180"></a>
<span class="sourceLineNo">181</span> @AfterClass<a name="line.181"></a>
<span class="sourceLineNo">182</span> public static void tearDownAfterClass() throws Exception {<a name="line.182"></a>
<span class="sourceLineNo">183</span> Closeables.close(CONN, true);<a name="line.183"></a>
<span class="sourceLineNo">184</span> TEST_UTIL.shutdownMiniCluster();<a name="line.184"></a>
<span class="sourceLineNo">185</span> }<a name="line.185"></a>
<span class="sourceLineNo">186</span><a name="line.186"></a>
<span class="sourceLineNo">187</span> @Before<a name="line.187"></a>
<span class="sourceLineNo">188</span> public void setupBeforeTest() throws Exception {<a name="line.188"></a>
<span class="sourceLineNo">189</span> disableSleeping();<a name="line.189"></a>
<span class="sourceLineNo">190</span> }<a name="line.190"></a>
<span class="sourceLineNo">191</span><a name="line.191"></a>
<span class="sourceLineNo">192</span> @After<a name="line.192"></a>
<span class="sourceLineNo">193</span> public void teardownAfterTest() throws Exception {<a name="line.193"></a>
<span class="sourceLineNo">194</span> disableSleeping();<a name="line.194"></a>
<span class="sourceLineNo">195</span> }<a name="line.195"></a>
<span class="sourceLineNo">196</span><a name="line.196"></a>
<span class="sourceLineNo">197</span> /**<a name="line.197"></a>
<span class="sourceLineNo">198</span> * Run the test callable when heartbeats are enabled/disabled. We expect all tests to only pass<a name="line.198"></a>
<span class="sourceLineNo">199</span> * when heartbeat messages are enabled (otherwise the test is pointless). When heartbeats are<a name="line.199"></a>
<span class="sourceLineNo">200</span> * disabled, the test should throw an exception.<a name="line.200"></a>
<span class="sourceLineNo">201</span> */<a name="line.201"></a>
<span class="sourceLineNo">202</span> private void testImportanceOfHeartbeats(Callable&lt;Void&gt; testCallable) throws InterruptedException {<a name="line.202"></a>
<span class="sourceLineNo">203</span> HeartbeatRPCServices.heartbeatsEnabled = true;<a name="line.203"></a>
<span class="sourceLineNo">204</span><a name="line.204"></a>
<span class="sourceLineNo">205</span> try {<a name="line.205"></a>
<span class="sourceLineNo">206</span> testCallable.call();<a name="line.206"></a>
<span class="sourceLineNo">207</span> } catch (Exception e) {<a name="line.207"></a>
<span class="sourceLineNo">208</span> fail("Heartbeat messages are enabled, exceptions should NOT be thrown. Exception trace:"<a name="line.208"></a>
<span class="sourceLineNo">209</span> + ExceptionUtils.getStackTrace(e));<a name="line.209"></a>
<span class="sourceLineNo">210</span> }<a name="line.210"></a>
<span class="sourceLineNo">211</span><a name="line.211"></a>
<span class="sourceLineNo">212</span> HeartbeatRPCServices.heartbeatsEnabled = false;<a name="line.212"></a>
<span class="sourceLineNo">213</span> try {<a name="line.213"></a>
<span class="sourceLineNo">214</span> testCallable.call();<a name="line.214"></a>
<span class="sourceLineNo">215</span> } catch (Exception e) {<a name="line.215"></a>
<span class="sourceLineNo">216</span> return;<a name="line.216"></a>
<span class="sourceLineNo">217</span> } finally {<a name="line.217"></a>
<span class="sourceLineNo">218</span> HeartbeatRPCServices.heartbeatsEnabled = true;<a name="line.218"></a>
<span class="sourceLineNo">219</span> }<a name="line.219"></a>
<span class="sourceLineNo">220</span> fail("Heartbeats messages are disabled, an exception should be thrown. If an exception "<a name="line.220"></a>
<span class="sourceLineNo">221</span> + " is not thrown, the test case is not testing the importance of heartbeat messages");<a name="line.221"></a>
<span class="sourceLineNo">222</span> }<a name="line.222"></a>
<span class="sourceLineNo">223</span><a name="line.223"></a>
<span class="sourceLineNo">224</span> /**<a name="line.224"></a>
<span class="sourceLineNo">225</span> * Test the case that the time limit for the scan is reached after each full row of cells is<a name="line.225"></a>
<span class="sourceLineNo">226</span> * fetched.<a name="line.226"></a>
<span class="sourceLineNo">227</span> */<a name="line.227"></a>
<span class="sourceLineNo">228</span> @Test<a name="line.228"></a>
<span class="sourceLineNo">229</span> public void testHeartbeatBetweenRows() throws Exception {<a name="line.229"></a>
<span class="sourceLineNo">230</span> testImportanceOfHeartbeats(new Callable&lt;Void&gt;() {<a name="line.230"></a>
<span class="sourceLineNo">231</span><a name="line.231"></a>
<span class="sourceLineNo">232</span> @Override<a name="line.232"></a>
<span class="sourceLineNo">233</span> public Void call() throws Exception {<a name="line.233"></a>
<span class="sourceLineNo">234</span> // Configure the scan so that it can read the entire table in a single RPC. We want to test<a name="line.234"></a>
<span class="sourceLineNo">235</span> // the case where a scan stops on the server side due to a time limit<a name="line.235"></a>
<span class="sourceLineNo">236</span> Scan scan = new Scan();<a name="line.236"></a>
<span class="sourceLineNo">237</span> scan.setMaxResultSize(Long.MAX_VALUE);<a name="line.237"></a>
<span class="sourceLineNo">238</span> scan.setCaching(Integer.MAX_VALUE);<a name="line.238"></a>
<span class="sourceLineNo">239</span><a name="line.239"></a>
<span class="sourceLineNo">240</span> testEquivalenceOfScanWithHeartbeats(scan, DEFAULT_ROW_SLEEP_TIME, -1, false);<a name="line.240"></a>
<span class="sourceLineNo">241</span> return null;<a name="line.241"></a>
<span class="sourceLineNo">242</span> }<a name="line.242"></a>
<span class="sourceLineNo">243</span> });<a name="line.243"></a>
<span class="sourceLineNo">244</span> }<a name="line.244"></a>
<span class="sourceLineNo">245</span><a name="line.245"></a>
<span class="sourceLineNo">246</span> /**<a name="line.246"></a>
<span class="sourceLineNo">247</span> * Test the case that the time limit for scans is reached in between column families<a name="line.247"></a>
<span class="sourceLineNo">248</span> */<a name="line.248"></a>
<span class="sourceLineNo">249</span> @Test<a name="line.249"></a>
<span class="sourceLineNo">250</span> public void testHeartbeatBetweenColumnFamilies() throws Exception {<a name="line.250"></a>
<span class="sourceLineNo">251</span> testImportanceOfHeartbeats(new Callable&lt;Void&gt;() {<a name="line.251"></a>
<span class="sourceLineNo">252</span> @Override<a name="line.252"></a>
<span class="sourceLineNo">253</span> public Void call() throws Exception {<a name="line.253"></a>
<span class="sourceLineNo">254</span> // Configure the scan so that it can read the entire table in a single RPC. We want to test<a name="line.254"></a>
<span class="sourceLineNo">255</span> // the case where a scan stops on the server side due to a time limit<a name="line.255"></a>
<span class="sourceLineNo">256</span> Scan baseScan = new Scan();<a name="line.256"></a>
<span class="sourceLineNo">257</span> baseScan.setMaxResultSize(Long.MAX_VALUE);<a name="line.257"></a>
<span class="sourceLineNo">258</span> baseScan.setCaching(Integer.MAX_VALUE);<a name="line.258"></a>
<span class="sourceLineNo">259</span><a name="line.259"></a>
<span class="sourceLineNo">260</span> // Copy the scan before each test. When a scan object is used by a scanner, some of its<a name="line.260"></a>
<span class="sourceLineNo">261</span> // fields may be changed such as start row<a name="line.261"></a>
<span class="sourceLineNo">262</span> Scan scanCopy = new Scan(baseScan);<a name="line.262"></a>
<span class="sourceLineNo">263</span> testEquivalenceOfScanWithHeartbeats(scanCopy, -1, DEFAULT_CF_SLEEP_TIME, false);<a name="line.263"></a>
<span class="sourceLineNo">264</span> scanCopy = new Scan(baseScan);<a name="line.264"></a>
<span class="sourceLineNo">265</span> testEquivalenceOfScanWithHeartbeats(scanCopy, -1, DEFAULT_CF_SLEEP_TIME, true);<a name="line.265"></a>
<span class="sourceLineNo">266</span> return null;<a name="line.266"></a>
<span class="sourceLineNo">267</span> }<a name="line.267"></a>
<span class="sourceLineNo">268</span> });<a name="line.268"></a>
<span class="sourceLineNo">269</span> }<a name="line.269"></a>
<span class="sourceLineNo">270</span><a name="line.270"></a>
<span class="sourceLineNo">271</span> public static class SparseCellFilter extends FilterBase {<a name="line.271"></a>
<span class="sourceLineNo">272</span><a name="line.272"></a>
<span class="sourceLineNo">273</span> @Override<a name="line.273"></a>
<span class="sourceLineNo">274</span> public ReturnCode filterCell(final Cell v) throws IOException {<a name="line.274"></a>
<span class="sourceLineNo">275</span> try {<a name="line.275"></a>
<span class="sourceLineNo">276</span> Thread.sleep(CLIENT_TIMEOUT / 2 + 100);<a name="line.276"></a>
<span class="sourceLineNo">277</span> } catch (InterruptedException e) {<a name="line.277"></a>
<span class="sourceLineNo">278</span> Thread.currentThread().interrupt();<a name="line.278"></a>
<span class="sourceLineNo">279</span> }<a name="line.279"></a>
<span class="sourceLineNo">280</span> return Bytes.equals(CellUtil.cloneRow(v), ROWS[NUM_ROWS - 1]) ? ReturnCode.INCLUDE<a name="line.280"></a>
<span class="sourceLineNo">281</span> : ReturnCode.SKIP;<a name="line.281"></a>
<span class="sourceLineNo">282</span> }<a name="line.282"></a>
<span class="sourceLineNo">283</span><a name="line.283"></a>
<span class="sourceLineNo">284</span> public static Filter parseFrom(final byte[] pbBytes) {<a name="line.284"></a>
<span class="sourceLineNo">285</span> return new SparseCellFilter();<a name="line.285"></a>
<span class="sourceLineNo">286</span> }<a name="line.286"></a>
<span class="sourceLineNo">287</span> }<a name="line.287"></a>
<span class="sourceLineNo">288</span><a name="line.288"></a>
<span class="sourceLineNo">289</span> public static class SparseRowFilter extends FilterBase {<a name="line.289"></a>
<span class="sourceLineNo">290</span><a name="line.290"></a>
<span class="sourceLineNo">291</span> @Override<a name="line.291"></a>
<span class="sourceLineNo">292</span> public boolean filterRowKey(Cell cell) throws IOException {<a name="line.292"></a>
<span class="sourceLineNo">293</span> try {<a name="line.293"></a>
<span class="sourceLineNo">294</span> Thread.sleep(CLIENT_TIMEOUT / 2 - 100);<a name="line.294"></a>
<span class="sourceLineNo">295</span> } catch (InterruptedException e) {<a name="line.295"></a>
<span class="sourceLineNo">296</span> Thread.currentThread().interrupt();<a name="line.296"></a>
<span class="sourceLineNo">297</span> }<a name="line.297"></a>
<span class="sourceLineNo">298</span> return !Bytes.equals(CellUtil.cloneRow(cell), ROWS[NUM_ROWS - 1]);<a name="line.298"></a>
<span class="sourceLineNo">299</span> }<a name="line.299"></a>
<span class="sourceLineNo">300</span><a name="line.300"></a>
<span class="sourceLineNo">301</span> public static Filter parseFrom(final byte[] pbBytes) {<a name="line.301"></a>
<span class="sourceLineNo">302</span> return new SparseRowFilter();<a name="line.302"></a>
<span class="sourceLineNo">303</span> }<a name="line.303"></a>
<span class="sourceLineNo">304</span> }<a name="line.304"></a>
<span class="sourceLineNo">305</span><a name="line.305"></a>
<span class="sourceLineNo">306</span> /**<a name="line.306"></a>
<span class="sourceLineNo">307</span> * Test the case that there is a filter which filters most of cells<a name="line.307"></a>
<span class="sourceLineNo">308</span> */<a name="line.308"></a>
<span class="sourceLineNo">309</span> @Test<a name="line.309"></a>
<span class="sourceLineNo">310</span> public void testHeartbeatWithSparseCellFilter() throws Exception {<a name="line.310"></a>
<span class="sourceLineNo">311</span> testImportanceOfHeartbeats(new Callable&lt;Void&gt;() {<a name="line.311"></a>
<span class="sourceLineNo">312</span> @Override<a name="line.312"></a>
<span class="sourceLineNo">313</span> public Void call() throws Exception {<a name="line.313"></a>
<span class="sourceLineNo">314</span> Scan scan = new Scan();<a name="line.314"></a>
<span class="sourceLineNo">315</span> scan.setMaxResultSize(Long.MAX_VALUE);<a name="line.315"></a>
<span class="sourceLineNo">316</span> scan.setCaching(Integer.MAX_VALUE);<a name="line.316"></a>
<span class="sourceLineNo">317</span> scan.setFilter(new SparseCellFilter());<a name="line.317"></a>
<span class="sourceLineNo">318</span> try (ScanPerNextResultScanner scanner =<a name="line.318"></a>
<span class="sourceLineNo">319</span> new ScanPerNextResultScanner(CONN.getTable(TABLE_NAME), scan)) {<a name="line.319"></a>
<span class="sourceLineNo">320</span> int num = 0;<a name="line.320"></a>
<span class="sourceLineNo">321</span> while (scanner.next() != null) {<a name="line.321"></a>
<span class="sourceLineNo">322</span> num++;<a name="line.322"></a>
<span class="sourceLineNo">323</span> }<a name="line.323"></a>
<span class="sourceLineNo">324</span> assertEquals(1, num);<a name="line.324"></a>
<span class="sourceLineNo">325</span> }<a name="line.325"></a>
<span class="sourceLineNo">326</span><a name="line.326"></a>
<span class="sourceLineNo">327</span> scan = new Scan();<a name="line.327"></a>
<span class="sourceLineNo">328</span> scan.setMaxResultSize(Long.MAX_VALUE);<a name="line.328"></a>
<span class="sourceLineNo">329</span> scan.setCaching(Integer.MAX_VALUE);<a name="line.329"></a>
<span class="sourceLineNo">330</span> scan.setFilter(new SparseCellFilter());<a name="line.330"></a>
<span class="sourceLineNo">331</span> scan.setAllowPartialResults(true);<a name="line.331"></a>
<span class="sourceLineNo">332</span> try (ScanPerNextResultScanner scanner =<a name="line.332"></a>
<span class="sourceLineNo">333</span> new ScanPerNextResultScanner(CONN.getTable(TABLE_NAME), scan)) {<a name="line.333"></a>
<span class="sourceLineNo">334</span> int num = 0;<a name="line.334"></a>
<span class="sourceLineNo">335</span> while (scanner.next() != null) {<a name="line.335"></a>
<span class="sourceLineNo">336</span> num++;<a name="line.336"></a>
<span class="sourceLineNo">337</span> }<a name="line.337"></a>
<span class="sourceLineNo">338</span> assertEquals(NUM_FAMILIES * NUM_QUALIFIERS, num);<a name="line.338"></a>
<span class="sourceLineNo">339</span> }<a name="line.339"></a>
<span class="sourceLineNo">340</span><a name="line.340"></a>
<span class="sourceLineNo">341</span> return null;<a name="line.341"></a>
<span class="sourceLineNo">342</span> }<a name="line.342"></a>
<span class="sourceLineNo">343</span> });<a name="line.343"></a>
<span class="sourceLineNo">344</span> }<a name="line.344"></a>
<span class="sourceLineNo">345</span><a name="line.345"></a>
<span class="sourceLineNo">346</span> /**<a name="line.346"></a>
<span class="sourceLineNo">347</span> * Test the case that there is a filter which filters most of rows<a name="line.347"></a>
<span class="sourceLineNo">348</span> */<a name="line.348"></a>
<span class="sourceLineNo">349</span> @Test<a name="line.349"></a>
<span class="sourceLineNo">350</span> public void testHeartbeatWithSparseRowFilter() throws Exception {<a name="line.350"></a>
<span class="sourceLineNo">351</span> testImportanceOfHeartbeats(new Callable&lt;Void&gt;() {<a name="line.351"></a>
<span class="sourceLineNo">352</span> @Override<a name="line.352"></a>
<span class="sourceLineNo">353</span> public Void call() throws Exception {<a name="line.353"></a>
<span class="sourceLineNo">354</span> Scan scan = new Scan();<a name="line.354"></a>
<span class="sourceLineNo">355</span> scan.setMaxResultSize(Long.MAX_VALUE);<a name="line.355"></a>
<span class="sourceLineNo">356</span> scan.setCaching(Integer.MAX_VALUE);<a name="line.356"></a>
<span class="sourceLineNo">357</span> scan.setFilter(new SparseRowFilter());<a name="line.357"></a>
<span class="sourceLineNo">358</span> try (ScanPerNextResultScanner scanner =<a name="line.358"></a>
<span class="sourceLineNo">359</span> new ScanPerNextResultScanner(CONN.getTable(TABLE_NAME), scan)) {<a name="line.359"></a>
<span class="sourceLineNo">360</span> int num = 0;<a name="line.360"></a>
<span class="sourceLineNo">361</span> while (scanner.next() != null) {<a name="line.361"></a>
<span class="sourceLineNo">362</span> num++;<a name="line.362"></a>
<span class="sourceLineNo">363</span> }<a name="line.363"></a>
<span class="sourceLineNo">364</span> assertEquals(1, num);<a name="line.364"></a>
<span class="sourceLineNo">365</span> }<a name="line.365"></a>
<span class="sourceLineNo">366</span><a name="line.366"></a>
<span class="sourceLineNo">367</span> return null;<a name="line.367"></a>
<span class="sourceLineNo">368</span> }<a name="line.368"></a>
<span class="sourceLineNo">369</span> });<a name="line.369"></a>
<span class="sourceLineNo">370</span> }<a name="line.370"></a>
<span class="sourceLineNo">371</span><a name="line.371"></a>
<span class="sourceLineNo">372</span> /**<a name="line.372"></a>
<span class="sourceLineNo">373</span> * Test the equivalence of a scan versus the same scan executed when heartbeat messages are<a name="line.373"></a>
<span class="sourceLineNo">374</span> * necessary<a name="line.374"></a>
<span class="sourceLineNo">375</span> * @param scan The scan configuration being tested<a name="line.375"></a>
<span class="sourceLineNo">376</span> * @param rowSleepTime The time to sleep between fetches of row cells<a name="line.376"></a>
<span class="sourceLineNo">377</span> * @param cfSleepTime The time to sleep between fetches of column family cells<a name="line.377"></a>
<span class="sourceLineNo">378</span> * @param sleepBeforeCf set to true when column family sleeps should occur before the cells for<a name="line.378"></a>
<span class="sourceLineNo">379</span> * that column family are fetched<a name="line.379"></a>
<span class="sourceLineNo">380</span> */<a name="line.380"></a>
<span class="sourceLineNo">381</span> private void testEquivalenceOfScanWithHeartbeats(final Scan scan, int rowSleepTime,<a name="line.381"></a>
<span class="sourceLineNo">382</span> int cfSleepTime, boolean sleepBeforeCf) throws Exception {<a name="line.382"></a>
<span class="sourceLineNo">383</span> disableSleeping();<a name="line.383"></a>
<span class="sourceLineNo">384</span> AsyncTable&lt;AdvancedScanResultConsumer&gt; table = CONN.getTable(TABLE_NAME);<a name="line.384"></a>
<span class="sourceLineNo">385</span> final ResultScanner scanner = new ScanPerNextResultScanner(table, scan);<a name="line.385"></a>
<span class="sourceLineNo">386</span> final ResultScanner scannerWithHeartbeats = new ScanPerNextResultScanner(table, scan);<a name="line.386"></a>
<span class="sourceLineNo">387</span><a name="line.387"></a>
<span class="sourceLineNo">388</span> Result r1 = null;<a name="line.388"></a>
<span class="sourceLineNo">389</span> Result r2 = null;<a name="line.389"></a>
<span class="sourceLineNo">390</span><a name="line.390"></a>
<span class="sourceLineNo">391</span> while ((r1 = scanner.next()) != null) {<a name="line.391"></a>
<span class="sourceLineNo">392</span> // Enforce the specified sleep conditions during calls to the heartbeat scanner<a name="line.392"></a>
<span class="sourceLineNo">393</span> configureSleepTime(rowSleepTime, cfSleepTime, sleepBeforeCf);<a name="line.393"></a>
<span class="sourceLineNo">394</span> r2 = scannerWithHeartbeats.next();<a name="line.394"></a>
<span class="sourceLineNo">395</span> disableSleeping();<a name="line.395"></a>
<span class="sourceLineNo">396</span><a name="line.396"></a>
<span class="sourceLineNo">397</span> assertTrue(r2 != null);<a name="line.397"></a>
<span class="sourceLineNo">398</span> try {<a name="line.398"></a>
<span class="sourceLineNo">399</span> Result.compareResults(r1, r2);<a name="line.399"></a>
<span class="sourceLineNo">400</span> } catch (Exception e) {<a name="line.400"></a>
<span class="sourceLineNo">401</span> fail(e.getMessage());<a name="line.401"></a>
<span class="sourceLineNo">402</span> }<a name="line.402"></a>
<span class="sourceLineNo">403</span> }<a name="line.403"></a>
<span class="sourceLineNo">404</span><a name="line.404"></a>
<span class="sourceLineNo">405</span> assertTrue(scannerWithHeartbeats.next() == null);<a name="line.405"></a>
<span class="sourceLineNo">406</span> scanner.close();<a name="line.406"></a>
<span class="sourceLineNo">407</span> scannerWithHeartbeats.close();<a name="line.407"></a>
<span class="sourceLineNo">408</span> }<a name="line.408"></a>
<span class="sourceLineNo">409</span><a name="line.409"></a>
<span class="sourceLineNo">410</span> /**<a name="line.410"></a>
<span class="sourceLineNo">411</span> * Helper method for setting the time to sleep between rows and column families. If a sleep time<a name="line.411"></a>
<span class="sourceLineNo">412</span> * is negative then that sleep will be disabled<a name="line.412"></a>
<span class="sourceLineNo">413</span> */<a name="line.413"></a>
<span class="sourceLineNo">414</span> private static void configureSleepTime(int rowSleepTime, int cfSleepTime, boolean sleepBeforeCf) {<a name="line.414"></a>
<span class="sourceLineNo">415</span> HeartbeatHRegion.sleepBetweenRows = rowSleepTime &gt; 0;<a name="line.415"></a>
<span class="sourceLineNo">416</span> HeartbeatHRegion.rowSleepTime = rowSleepTime;<a name="line.416"></a>
<span class="sourceLineNo">417</span><a name="line.417"></a>
<span class="sourceLineNo">418</span> HeartbeatHRegion.sleepBetweenColumnFamilies = cfSleepTime &gt; 0;<a name="line.418"></a>
<span class="sourceLineNo">419</span> HeartbeatHRegion.columnFamilySleepTime = cfSleepTime;<a name="line.419"></a>
<span class="sourceLineNo">420</span> HeartbeatHRegion.sleepBeforeColumnFamily = sleepBeforeCf;<a name="line.420"></a>
<span class="sourceLineNo">421</span> }<a name="line.421"></a>
<span class="sourceLineNo">422</span><a name="line.422"></a>
<span class="sourceLineNo">423</span> /**<a name="line.423"></a>
<span class="sourceLineNo">424</span> * Disable the sleeping mechanism server side.<a name="line.424"></a>
<span class="sourceLineNo">425</span> */<a name="line.425"></a>
<span class="sourceLineNo">426</span> private static void disableSleeping() {<a name="line.426"></a>
<span class="sourceLineNo">427</span> HeartbeatHRegion.sleepBetweenRows = false;<a name="line.427"></a>
<span class="sourceLineNo">428</span> HeartbeatHRegion.sleepBetweenColumnFamilies = false;<a name="line.428"></a>
<span class="sourceLineNo">429</span> }<a name="line.429"></a>
<span class="sourceLineNo">430</span><a name="line.430"></a>
<span class="sourceLineNo">431</span> /**<a name="line.431"></a>
<span class="sourceLineNo">432</span> * Custom HRegionServer instance that instantiates {@link HeartbeatRPCServices} in place of<a name="line.432"></a>
<span class="sourceLineNo">433</span> * {@link RSRpcServices} to allow us to toggle support for heartbeat messages<a name="line.433"></a>
<span class="sourceLineNo">434</span> */<a name="line.434"></a>
<span class="sourceLineNo">435</span> private static class HeartbeatHRegionServer extends HRegionServer {<a name="line.435"></a>
<span class="sourceLineNo">436</span> public HeartbeatHRegionServer(Configuration conf) throws IOException, InterruptedException {<a name="line.436"></a>
<span class="sourceLineNo">437</span> super(conf);<a name="line.437"></a>
<span class="sourceLineNo">438</span> }<a name="line.438"></a>
<span class="sourceLineNo">439</span><a name="line.439"></a>
<span class="sourceLineNo">440</span> @Override<a name="line.440"></a>
<span class="sourceLineNo">441</span> protected RSRpcServices createRpcServices() throws IOException {<a name="line.441"></a>
<span class="sourceLineNo">442</span> return new HeartbeatRPCServices(this);<a name="line.442"></a>
<span class="sourceLineNo">443</span> }<a name="line.443"></a>
<span class="sourceLineNo">444</span> }<a name="line.444"></a>
<span class="sourceLineNo">445</span><a name="line.445"></a>
<span class="sourceLineNo">446</span> /**<a name="line.446"></a>
<span class="sourceLineNo">447</span> * Custom RSRpcServices instance that allows heartbeat support to be toggled<a name="line.447"></a>
<span class="sourceLineNo">448</span> */<a name="line.448"></a>
<span class="sourceLineNo">449</span> private static class HeartbeatRPCServices extends RSRpcServices {<a name="line.449"></a>
<span class="sourceLineNo">450</span> private static volatile boolean heartbeatsEnabled = true;<a name="line.450"></a>
<span class="sourceLineNo">451</span><a name="line.451"></a>
<span class="sourceLineNo">452</span> public HeartbeatRPCServices(HRegionServer rs) throws IOException {<a name="line.452"></a>
<span class="sourceLineNo">453</span> super(rs);<a name="line.453"></a>
<span class="sourceLineNo">454</span> }<a name="line.454"></a>
<span class="sourceLineNo">455</span><a name="line.455"></a>
<span class="sourceLineNo">456</span> @Override<a name="line.456"></a>
<span class="sourceLineNo">457</span> public ScanResponse scan(RpcController controller, ScanRequest request)<a name="line.457"></a>
<span class="sourceLineNo">458</span> throws ServiceException {<a name="line.458"></a>
<span class="sourceLineNo">459</span> ScanRequest.Builder builder = ScanRequest.newBuilder(request);<a name="line.459"></a>
<span class="sourceLineNo">460</span> builder.setClientHandlesHeartbeats(heartbeatsEnabled);<a name="line.460"></a>
<span class="sourceLineNo">461</span> return super.scan(controller, builder.build());<a name="line.461"></a>
<span class="sourceLineNo">462</span> }<a name="line.462"></a>
<span class="sourceLineNo">463</span> }<a name="line.463"></a>
<span class="sourceLineNo">464</span><a name="line.464"></a>
<span class="sourceLineNo">465</span> /**<a name="line.465"></a>
<span class="sourceLineNo">466</span> * Custom HRegion class that instantiates {@link RegionScanner}s with configurable sleep times<a name="line.466"></a>
<span class="sourceLineNo">467</span> * between fetches of row Results and/or column family cells. Useful for emulating an instance<a name="line.467"></a>
<span class="sourceLineNo">468</span> * where the server is taking a long time to process a client's scan request<a name="line.468"></a>
<span class="sourceLineNo">469</span> */<a name="line.469"></a>
<span class="sourceLineNo">470</span> private static class HeartbeatHRegion extends HRegion {<a name="line.470"></a>
<span class="sourceLineNo">471</span> // Row sleeps occur AFTER each row worth of cells is retrieved.<a name="line.471"></a>
<span class="sourceLineNo">472</span> private static volatile int rowSleepTime = DEFAULT_ROW_SLEEP_TIME;<a name="line.472"></a>
<span class="sourceLineNo">473</span> private static volatile boolean sleepBetweenRows = false;<a name="line.473"></a>
<span class="sourceLineNo">474</span><a name="line.474"></a>
<span class="sourceLineNo">475</span> // The sleep for column families can be initiated before or after we fetch the cells for the<a name="line.475"></a>
<span class="sourceLineNo">476</span> // column family. If the sleep occurs BEFORE then the time limits will be reached inside<a name="line.476"></a>
<span class="sourceLineNo">477</span> // StoreScanner while we are fetching individual cells. If the sleep occurs AFTER then the time<a name="line.477"></a>
<span class="sourceLineNo">478</span> // limit will be reached inside RegionScanner after all the cells for a column family have been<a name="line.478"></a>
<span class="sourceLineNo">479</span> // retrieved.<a name="line.479"></a>
<span class="sourceLineNo">480</span> private static volatile boolean sleepBeforeColumnFamily = false;<a name="line.480"></a>
<span class="sourceLineNo">481</span> private static volatile int columnFamilySleepTime = DEFAULT_CF_SLEEP_TIME;<a name="line.481"></a>
<span class="sourceLineNo">482</span> private static volatile boolean sleepBetweenColumnFamilies = false;<a name="line.482"></a>
<span class="sourceLineNo">483</span><a name="line.483"></a>
<span class="sourceLineNo">484</span> public HeartbeatHRegion(Path tableDir, WAL wal, FileSystem fs, Configuration confParam,<a name="line.484"></a>
<span class="sourceLineNo">485</span> RegionInfo regionInfo, TableDescriptor htd, RegionServerServices rsServices) {<a name="line.485"></a>
<span class="sourceLineNo">486</span> super(tableDir, wal, fs, confParam, regionInfo, htd, rsServices);<a name="line.486"></a>
<span class="sourceLineNo">487</span> }<a name="line.487"></a>
<span class="sourceLineNo">488</span><a name="line.488"></a>
<span class="sourceLineNo">489</span> public HeartbeatHRegion(HRegionFileSystem fs, WAL wal, Configuration confParam,<a name="line.489"></a>
<span class="sourceLineNo">490</span> TableDescriptor htd, RegionServerServices rsServices) {<a name="line.490"></a>
<span class="sourceLineNo">491</span> super(fs, wal, confParam, htd, rsServices);<a name="line.491"></a>
<span class="sourceLineNo">492</span> }<a name="line.492"></a>
<span class="sourceLineNo">493</span><a name="line.493"></a>
<span class="sourceLineNo">494</span> private static void columnFamilySleep() {<a name="line.494"></a>
<span class="sourceLineNo">495</span> if (sleepBetweenColumnFamilies) {<a name="line.495"></a>
<span class="sourceLineNo">496</span> Threads.sleepWithoutInterrupt(columnFamilySleepTime);<a name="line.496"></a>
<span class="sourceLineNo">497</span> }<a name="line.497"></a>
<span class="sourceLineNo">498</span> }<a name="line.498"></a>
<span class="sourceLineNo">499</span><a name="line.499"></a>
<span class="sourceLineNo">500</span> private static void rowSleep() {<a name="line.500"></a>
<span class="sourceLineNo">501</span> if (sleepBetweenRows) {<a name="line.501"></a>
<span class="sourceLineNo">502</span> Threads.sleepWithoutInterrupt(rowSleepTime);<a name="line.502"></a>
<span class="sourceLineNo">503</span> }<a name="line.503"></a>
<span class="sourceLineNo">504</span> }<a name="line.504"></a>
<span class="sourceLineNo">505</span><a name="line.505"></a>
<span class="sourceLineNo">506</span> // Instantiate the custom heartbeat region scanners<a name="line.506"></a>
<span class="sourceLineNo">507</span> @Override<a name="line.507"></a>
<span class="sourceLineNo">508</span> protected RegionScannerImpl instantiateRegionScanner(Scan scan,<a name="line.508"></a>
<span class="sourceLineNo">509</span> List&lt;KeyValueScanner&gt; additionalScanners, long nonceGroup, long nonce) throws IOException {<a name="line.509"></a>
<span class="sourceLineNo">510</span> if (scan.isReversed()) {<a name="line.510"></a>
<span class="sourceLineNo">511</span> if (scan.getFilter() != null) {<a name="line.511"></a>
<span class="sourceLineNo">512</span> scan.getFilter().setReversed(true);<a name="line.512"></a>
<span class="sourceLineNo">513</span> }<a name="line.513"></a>
<span class="sourceLineNo">514</span> return new HeartbeatReversedRegionScanner(scan, additionalScanners, this);<a name="line.514"></a>
<span class="sourceLineNo">515</span> }<a name="line.515"></a>
<span class="sourceLineNo">516</span> return new HeartbeatRegionScanner(scan, additionalScanners, this);<a name="line.516"></a>
<span class="sourceLineNo">517</span> }<a name="line.517"></a>
<span class="sourceLineNo">518</span> }<a name="line.518"></a>
<span class="sourceLineNo">519</span><a name="line.519"></a>
<span class="sourceLineNo">520</span> /**<a name="line.520"></a>
<span class="sourceLineNo">521</span> * Custom ReversedRegionScanner that can be configured to sleep between retrievals of row Results<a name="line.521"></a>
<span class="sourceLineNo">522</span> * and/or column family cells<a name="line.522"></a>
<span class="sourceLineNo">523</span> */<a name="line.523"></a>
<span class="sourceLineNo">524</span> private static class HeartbeatReversedRegionScanner extends ReversedRegionScannerImpl {<a name="line.524"></a>
<span class="sourceLineNo">525</span> HeartbeatReversedRegionScanner(Scan scan, List&lt;KeyValueScanner&gt; additionalScanners,<a name="line.525"></a>
<span class="sourceLineNo">526</span> HRegion region) throws IOException {<a name="line.526"></a>
<span class="sourceLineNo">527</span> super(scan, additionalScanners, region, HConstants.NO_NONCE, HConstants.NO_NONCE);<a name="line.527"></a>
<span class="sourceLineNo">528</span> }<a name="line.528"></a>
<span class="sourceLineNo">529</span><a name="line.529"></a>
<span class="sourceLineNo">530</span> @Override<a name="line.530"></a>
<span class="sourceLineNo">531</span> public boolean nextRaw(List&lt;Cell&gt; outResults, ScannerContext context) throws IOException {<a name="line.531"></a>
<span class="sourceLineNo">532</span> boolean moreRows = super.nextRaw(outResults, context);<a name="line.532"></a>
<span class="sourceLineNo">533</span> HeartbeatHRegion.rowSleep();<a name="line.533"></a>
<span class="sourceLineNo">534</span> return moreRows;<a name="line.534"></a>
<span class="sourceLineNo">535</span> }<a name="line.535"></a>
<span class="sourceLineNo">536</span><a name="line.536"></a>
<span class="sourceLineNo">537</span> @Override<a name="line.537"></a>
<span class="sourceLineNo">538</span> protected void initializeKVHeap(List&lt;KeyValueScanner&gt; scanners,<a name="line.538"></a>
<span class="sourceLineNo">539</span> List&lt;KeyValueScanner&gt; joinedScanners, HRegion region) throws IOException {<a name="line.539"></a>
<span class="sourceLineNo">540</span> this.storeHeap =<a name="line.540"></a>
<span class="sourceLineNo">541</span> new HeartbeatReversedKVHeap(scanners, (CellComparatorImpl) region.getCellComparator());<a name="line.541"></a>
<span class="sourceLineNo">542</span> if (!joinedScanners.isEmpty()) {<a name="line.542"></a>
<span class="sourceLineNo">543</span> this.joinedHeap = new HeartbeatReversedKVHeap(joinedScanners,<a name="line.543"></a>
<span class="sourceLineNo">544</span> (CellComparatorImpl) region.getCellComparator());<a name="line.544"></a>
<span class="sourceLineNo">545</span> }<a name="line.545"></a>
<span class="sourceLineNo">546</span> }<a name="line.546"></a>
<span class="sourceLineNo">547</span> }<a name="line.547"></a>
<span class="sourceLineNo">548</span><a name="line.548"></a>
<span class="sourceLineNo">549</span> /**<a name="line.549"></a>
<span class="sourceLineNo">550</span> * Custom RegionScanner that can be configured to sleep between retrievals of row Results and/or<a name="line.550"></a>
<span class="sourceLineNo">551</span> * column family cells<a name="line.551"></a>
<span class="sourceLineNo">552</span> */<a name="line.552"></a>
<span class="sourceLineNo">553</span> private static class HeartbeatRegionScanner extends RegionScannerImpl {<a name="line.553"></a>
<span class="sourceLineNo">554</span> HeartbeatRegionScanner(Scan scan, List&lt;KeyValueScanner&gt; additionalScanners, HRegion region)<a name="line.554"></a>
<span class="sourceLineNo">555</span> throws IOException {<a name="line.555"></a>
<span class="sourceLineNo">556</span> super(scan, additionalScanners, region, HConstants.NO_NONCE, HConstants.NO_NONCE);<a name="line.556"></a>
<span class="sourceLineNo">557</span> }<a name="line.557"></a>
<span class="sourceLineNo">558</span><a name="line.558"></a>
<span class="sourceLineNo">559</span> @Override<a name="line.559"></a>
<span class="sourceLineNo">560</span> public boolean nextRaw(List&lt;Cell&gt; outResults, ScannerContext context) throws IOException {<a name="line.560"></a>
<span class="sourceLineNo">561</span> boolean moreRows = super.nextRaw(outResults, context);<a name="line.561"></a>
<span class="sourceLineNo">562</span> HeartbeatHRegion.rowSleep();<a name="line.562"></a>
<span class="sourceLineNo">563</span> return moreRows;<a name="line.563"></a>
<span class="sourceLineNo">564</span> }<a name="line.564"></a>
<span class="sourceLineNo">565</span><a name="line.565"></a>
<span class="sourceLineNo">566</span> @Override<a name="line.566"></a>
<span class="sourceLineNo">567</span> protected void initializeKVHeap(List&lt;KeyValueScanner&gt; scanners,<a name="line.567"></a>
<span class="sourceLineNo">568</span> List&lt;KeyValueScanner&gt; joinedScanners, HRegion region) throws IOException {<a name="line.568"></a>
<span class="sourceLineNo">569</span> this.storeHeap =<a name="line.569"></a>
<span class="sourceLineNo">570</span> new HeartbeatKVHeap(scanners, region.getCellComparator());<a name="line.570"></a>
<span class="sourceLineNo">571</span> if (!joinedScanners.isEmpty()) {<a name="line.571"></a>
<span class="sourceLineNo">572</span> this.joinedHeap =<a name="line.572"></a>
<span class="sourceLineNo">573</span> new HeartbeatKVHeap(joinedScanners, region.getCellComparator());<a name="line.573"></a>
<span class="sourceLineNo">574</span> }<a name="line.574"></a>
<span class="sourceLineNo">575</span> }<a name="line.575"></a>
<span class="sourceLineNo">576</span> }<a name="line.576"></a>
<span class="sourceLineNo">577</span><a name="line.577"></a>
<span class="sourceLineNo">578</span> /**<a name="line.578"></a>
<span class="sourceLineNo">579</span> * Custom KV Heap that can be configured to sleep/wait in between retrievals of column family<a name="line.579"></a>
<span class="sourceLineNo">580</span> * cells. Useful for testing<a name="line.580"></a>
<span class="sourceLineNo">581</span> */<a name="line.581"></a>
<span class="sourceLineNo">582</span> private static final class HeartbeatKVHeap extends KeyValueHeap {<a name="line.582"></a>
<span class="sourceLineNo">583</span> public HeartbeatKVHeap(List&lt;? extends KeyValueScanner&gt; scanners, CellComparator comparator)<a name="line.583"></a>
<span class="sourceLineNo">584</span> throws IOException {<a name="line.584"></a>
<span class="sourceLineNo">585</span> super(scanners, comparator);<a name="line.585"></a>
<span class="sourceLineNo">586</span> }<a name="line.586"></a>
<span class="sourceLineNo">587</span><a name="line.587"></a>
<span class="sourceLineNo">588</span> HeartbeatKVHeap(List&lt;? extends KeyValueScanner&gt; scanners, KVScannerComparator comparator)<a name="line.588"></a>
<span class="sourceLineNo">589</span> throws IOException {<a name="line.589"></a>
<span class="sourceLineNo">590</span> super(scanners, comparator);<a name="line.590"></a>
<span class="sourceLineNo">591</span> }<a name="line.591"></a>
<span class="sourceLineNo">592</span><a name="line.592"></a>
<span class="sourceLineNo">593</span> @Override<a name="line.593"></a>
<span class="sourceLineNo">594</span> public boolean next(List&lt;Cell&gt; result, ScannerContext context) throws IOException {<a name="line.594"></a>
<span class="sourceLineNo">595</span> if (HeartbeatHRegion.sleepBeforeColumnFamily) HeartbeatHRegion.columnFamilySleep();<a name="line.595"></a>
<span class="sourceLineNo">596</span> boolean moreRows = super.next(result, context);<a name="line.596"></a>
<span class="sourceLineNo">597</span> if (!HeartbeatHRegion.sleepBeforeColumnFamily) HeartbeatHRegion.columnFamilySleep();<a name="line.597"></a>
<span class="sourceLineNo">598</span> return moreRows;<a name="line.598"></a>
<span class="sourceLineNo">599</span> }<a name="line.599"></a>
<span class="sourceLineNo">600</span> }<a name="line.600"></a>
<span class="sourceLineNo">601</span><a name="line.601"></a>
<span class="sourceLineNo">602</span> /**<a name="line.602"></a>
<span class="sourceLineNo">603</span> * Custom reversed KV Heap that can be configured to sleep in between retrievals of column family<a name="line.603"></a>
<span class="sourceLineNo">604</span> * cells.<a name="line.604"></a>
<span class="sourceLineNo">605</span> */<a name="line.605"></a>
<span class="sourceLineNo">606</span> private static final class HeartbeatReversedKVHeap extends ReversedKeyValueHeap {<a name="line.606"></a>
<span class="sourceLineNo">607</span> public HeartbeatReversedKVHeap(List&lt;? extends KeyValueScanner&gt; scanners,<a name="line.607"></a>
<span class="sourceLineNo">608</span> CellComparatorImpl comparator) throws IOException {<a name="line.608"></a>
<span class="sourceLineNo">609</span> super(scanners, comparator);<a name="line.609"></a>
<span class="sourceLineNo">610</span> }<a name="line.610"></a>
<span class="sourceLineNo">611</span><a name="line.611"></a>
<span class="sourceLineNo">612</span> @Override<a name="line.612"></a>
<span class="sourceLineNo">613</span> public boolean next(List&lt;Cell&gt; result, ScannerContext context) throws IOException {<a name="line.613"></a>
<span class="sourceLineNo">614</span> if (HeartbeatHRegion.sleepBeforeColumnFamily) HeartbeatHRegion.columnFamilySleep();<a name="line.614"></a>
<span class="sourceLineNo">615</span> boolean moreRows = super.next(result, context);<a name="line.615"></a>
<span class="sourceLineNo">616</span> if (!HeartbeatHRegion.sleepBeforeColumnFamily) HeartbeatHRegion.columnFamilySleep();<a name="line.616"></a>
<span class="sourceLineNo">617</span> return moreRows;<a name="line.617"></a>
<span class="sourceLineNo">618</span> }<a name="line.618"></a>
<span class="sourceLineNo">619</span> }<a name="line.619"></a>
<span class="sourceLineNo">620</span>}<a name="line.620"></a>
</pre>
</div>
</body>
</html>