You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hbase.apache.org by mi...@apache.org on 2016/03/18 20:02:22 UTC
[16/23] hbase-site git commit: Published site at
3a6d683d63089c1986e68e531939df7328e58300.
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/07fa263b/devapidocs/src-html/org/apache/hadoop/hbase/client/ClientScanner.html
----------------------------------------------------------------------
diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/client/ClientScanner.html b/devapidocs/src-html/org/apache/hadoop/hbase/client/ClientScanner.html
index 6296370..210e2c9 100644
--- a/devapidocs/src-html/org/apache/hadoop/hbase/client/ClientScanner.html
+++ b/devapidocs/src-html/org/apache/hadoop/hbase/client/ClientScanner.html
@@ -30,768 +30,846 @@
<span class="sourceLineNo">022</span>import org.apache.commons.logging.LogFactory;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.hadoop.conf.Configuration;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.Cell;<a name="line.24"></a>
-<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.CellUtil;<a name="line.25"></a>
-<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.DoNotRetryIOException;<a name="line.26"></a>
-<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.HBaseConfiguration;<a name="line.27"></a>
-<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.HConstants;<a name="line.28"></a>
-<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.HRegionInfo;<a name="line.29"></a>
-<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.NotServingRegionException;<a name="line.30"></a>
-<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.TableName;<a name="line.31"></a>
-<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.UnknownScannerException;<a name="line.32"></a>
-<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.classification.InterfaceAudience;<a name="line.33"></a>
-<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.exceptions.OutOfOrderScannerNextException;<a name="line.34"></a>
-<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.ipc.RpcControllerFactory;<a name="line.35"></a>
-<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.protobuf.ProtobufUtil;<a name="line.36"></a>
-<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.protobuf.generated.MapReduceProtos;<a name="line.37"></a>
-<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.regionserver.RegionServerStoppedException;<a name="line.38"></a>
-<span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.39"></a>
-<span class="sourceLineNo">040</span><a name="line.40"></a>
-<span class="sourceLineNo">041</span>import java.io.IOException;<a name="line.41"></a>
-<span class="sourceLineNo">042</span>import java.io.InterruptedIOException;<a name="line.42"></a>
-<span class="sourceLineNo">043</span>import java.util.ArrayList;<a name="line.43"></a>
-<span class="sourceLineNo">044</span>import java.util.Arrays;<a name="line.44"></a>
-<span class="sourceLineNo">045</span>import java.util.LinkedList;<a name="line.45"></a>
-<span class="sourceLineNo">046</span>import java.util.List;<a name="line.46"></a>
-<span class="sourceLineNo">047</span>import java.util.Queue;<a name="line.47"></a>
-<span class="sourceLineNo">048</span>import java.util.concurrent.ExecutorService;<a name="line.48"></a>
-<span class="sourceLineNo">049</span><a name="line.49"></a>
-<span class="sourceLineNo">050</span>/**<a name="line.50"></a>
-<span class="sourceLineNo">051</span> * Implements the scanner interface for the HBase client.<a name="line.51"></a>
-<span class="sourceLineNo">052</span> * If there are multiple regions in a table, this scanner will iterate<a name="line.52"></a>
-<span class="sourceLineNo">053</span> * through them all.<a name="line.53"></a>
-<span class="sourceLineNo">054</span> */<a name="line.54"></a>
-<span class="sourceLineNo">055</span>@InterfaceAudience.Private<a name="line.55"></a>
-<span class="sourceLineNo">056</span>public abstract class ClientScanner extends AbstractClientScanner {<a name="line.56"></a>
-<span class="sourceLineNo">057</span> private static final Log LOG = LogFactory.getLog(ClientScanner.class);<a name="line.57"></a>
-<span class="sourceLineNo">058</span> // A byte array in which all elements are the max byte, and it is used to<a name="line.58"></a>
-<span class="sourceLineNo">059</span> // construct closest front row<a name="line.59"></a>
-<span class="sourceLineNo">060</span> static byte[] MAX_BYTE_ARRAY = Bytes.createMaxByteArray(9);<a name="line.60"></a>
-<span class="sourceLineNo">061</span> protected Scan scan;<a name="line.61"></a>
-<span class="sourceLineNo">062</span> protected boolean closed = false;<a name="line.62"></a>
-<span class="sourceLineNo">063</span> // Current region scanner is against. Gets cleared if current region goes<a name="line.63"></a>
-<span class="sourceLineNo">064</span> // wonky: e.g. if it splits on us.<a name="line.64"></a>
-<span class="sourceLineNo">065</span> protected HRegionInfo currentRegion = null;<a name="line.65"></a>
-<span class="sourceLineNo">066</span> protected ScannerCallableWithReplicas callable = null;<a name="line.66"></a>
-<span class="sourceLineNo">067</span> protected Queue<Result> cache;<a name="line.67"></a>
-<span class="sourceLineNo">068</span> /**<a name="line.68"></a>
-<span class="sourceLineNo">069</span> * A list of partial results that have been returned from the server. This list should only<a name="line.69"></a>
-<span class="sourceLineNo">070</span> * contain results if this scanner does not have enough partial results to form the complete<a name="line.70"></a>
-<span class="sourceLineNo">071</span> * result.<a name="line.71"></a>
-<span class="sourceLineNo">072</span> */<a name="line.72"></a>
-<span class="sourceLineNo">073</span> protected final LinkedList<Result> partialResults = new LinkedList<Result>();<a name="line.73"></a>
-<span class="sourceLineNo">074</span> /**<a name="line.74"></a>
-<span class="sourceLineNo">075</span> * The row for which we are accumulating partial Results (i.e. the row of the Results stored<a name="line.75"></a>
-<span class="sourceLineNo">076</span> * inside partialResults). Changes to partialResultsRow and partialResults are kept in sync<a name="line.76"></a>
-<span class="sourceLineNo">077</span> * via the methods {@link #addToPartialResults(Result)} and {@link #clearPartialResults()}<a name="line.77"></a>
-<span class="sourceLineNo">078</span> */<a name="line.78"></a>
-<span class="sourceLineNo">079</span> protected byte[] partialResultsRow = null;<a name="line.79"></a>
-<span class="sourceLineNo">080</span> protected final int caching;<a name="line.80"></a>
-<span class="sourceLineNo">081</span> protected long lastNext;<a name="line.81"></a>
-<span class="sourceLineNo">082</span> // Keep lastResult returned successfully in case we have to reset scanner.<a name="line.82"></a>
-<span class="sourceLineNo">083</span> protected Result lastResult = null;<a name="line.83"></a>
-<span class="sourceLineNo">084</span> protected final long maxScannerResultSize;<a name="line.84"></a>
-<span class="sourceLineNo">085</span> private final ClusterConnection connection;<a name="line.85"></a>
-<span class="sourceLineNo">086</span> private final TableName tableName;<a name="line.86"></a>
-<span class="sourceLineNo">087</span> protected final int scannerTimeout;<a name="line.87"></a>
-<span class="sourceLineNo">088</span> protected boolean scanMetricsPublished = false;<a name="line.88"></a>
-<span class="sourceLineNo">089</span> protected RpcRetryingCaller<Result []> caller;<a name="line.89"></a>
-<span class="sourceLineNo">090</span> protected RpcControllerFactory rpcControllerFactory;<a name="line.90"></a>
-<span class="sourceLineNo">091</span> protected Configuration conf;<a name="line.91"></a>
-<span class="sourceLineNo">092</span> //The timeout on the primary. Applicable if there are multiple replicas for a region<a name="line.92"></a>
-<span class="sourceLineNo">093</span> //In that case, we will only wait for this much timeout on the primary before going<a name="line.93"></a>
-<span class="sourceLineNo">094</span> //to the replicas and trying the same scan. Note that the retries will still happen<a name="line.94"></a>
-<span class="sourceLineNo">095</span> //on each replica and the first successful results will be taken. A timeout of 0 is<a name="line.95"></a>
-<span class="sourceLineNo">096</span> //disallowed.<a name="line.96"></a>
-<span class="sourceLineNo">097</span> protected final int primaryOperationTimeout;<a name="line.97"></a>
-<span class="sourceLineNo">098</span> private int retries;<a name="line.98"></a>
-<span class="sourceLineNo">099</span> protected final ExecutorService pool;<a name="line.99"></a>
-<span class="sourceLineNo">100</span><a name="line.100"></a>
-<span class="sourceLineNo">101</span> /**<a name="line.101"></a>
-<span class="sourceLineNo">102</span> * Create a new ClientScanner for the specified table Note that the passed {@link Scan}'s start<a name="line.102"></a>
-<span class="sourceLineNo">103</span> * row maybe changed changed.<a name="line.103"></a>
-<span class="sourceLineNo">104</span> * @param conf The {@link Configuration} to use.<a name="line.104"></a>
-<span class="sourceLineNo">105</span> * @param scan {@link Scan} to use in this scanner<a name="line.105"></a>
-<span class="sourceLineNo">106</span> * @param tableName The table that we wish to scan<a name="line.106"></a>
-<span class="sourceLineNo">107</span> * @param connection Connection identifying the cluster<a name="line.107"></a>
-<span class="sourceLineNo">108</span> * @throws IOException<a name="line.108"></a>
-<span class="sourceLineNo">109</span> */<a name="line.109"></a>
-<span class="sourceLineNo">110</span> public ClientScanner(final Configuration conf, final Scan scan, final TableName tableName,<a name="line.110"></a>
-<span class="sourceLineNo">111</span> ClusterConnection connection, RpcRetryingCallerFactory rpcFactory,<a name="line.111"></a>
-<span class="sourceLineNo">112</span> RpcControllerFactory controllerFactory, ExecutorService pool, int primaryOperationTimeout)<a name="line.112"></a>
-<span class="sourceLineNo">113</span> throws IOException {<a name="line.113"></a>
-<span class="sourceLineNo">114</span> if (LOG.isTraceEnabled()) {<a name="line.114"></a>
-<span class="sourceLineNo">115</span> LOG.trace("Scan table=" + tableName<a name="line.115"></a>
-<span class="sourceLineNo">116</span> + ", startRow=" + Bytes.toStringBinary(scan.getStartRow()));<a name="line.116"></a>
-<span class="sourceLineNo">117</span> }<a name="line.117"></a>
-<span class="sourceLineNo">118</span> this.scan = scan;<a name="line.118"></a>
-<span class="sourceLineNo">119</span> this.tableName = tableName;<a name="line.119"></a>
-<span class="sourceLineNo">120</span> this.lastNext = System.currentTimeMillis();<a name="line.120"></a>
-<span class="sourceLineNo">121</span> this.connection = connection;<a name="line.121"></a>
-<span class="sourceLineNo">122</span> this.pool = pool;<a name="line.122"></a>
-<span class="sourceLineNo">123</span> this.primaryOperationTimeout = primaryOperationTimeout;<a name="line.123"></a>
-<span class="sourceLineNo">124</span> this.retries = conf.getInt(HConstants.HBASE_CLIENT_RETRIES_NUMBER,<a name="line.124"></a>
-<span class="sourceLineNo">125</span> HConstants.DEFAULT_HBASE_CLIENT_RETRIES_NUMBER);<a name="line.125"></a>
-<span class="sourceLineNo">126</span> if (scan.getMaxResultSize() > 0) {<a name="line.126"></a>
-<span class="sourceLineNo">127</span> this.maxScannerResultSize = scan.getMaxResultSize();<a name="line.127"></a>
-<span class="sourceLineNo">128</span> } else {<a name="line.128"></a>
-<span class="sourceLineNo">129</span> this.maxScannerResultSize = conf.getLong(<a name="line.129"></a>
-<span class="sourceLineNo">130</span> HConstants.HBASE_CLIENT_SCANNER_MAX_RESULT_SIZE_KEY,<a name="line.130"></a>
-<span class="sourceLineNo">131</span> HConstants.DEFAULT_HBASE_CLIENT_SCANNER_MAX_RESULT_SIZE);<a name="line.131"></a>
-<span class="sourceLineNo">132</span> }<a name="line.132"></a>
-<span class="sourceLineNo">133</span> this.scannerTimeout = HBaseConfiguration.getInt(conf,<a name="line.133"></a>
-<span class="sourceLineNo">134</span> HConstants.HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD,<a name="line.134"></a>
-<span class="sourceLineNo">135</span> HConstants.HBASE_REGIONSERVER_LEASE_PERIOD_KEY,<a name="line.135"></a>
-<span class="sourceLineNo">136</span> HConstants.DEFAULT_HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD);<a name="line.136"></a>
-<span class="sourceLineNo">137</span><a name="line.137"></a>
-<span class="sourceLineNo">138</span> // check if application wants to collect scan metrics<a name="line.138"></a>
-<span class="sourceLineNo">139</span> initScanMetrics(scan);<a name="line.139"></a>
-<span class="sourceLineNo">140</span><a name="line.140"></a>
-<span class="sourceLineNo">141</span> // Use the caching from the Scan. If not set, use the default cache setting for this table.<a name="line.141"></a>
-<span class="sourceLineNo">142</span> if (this.scan.getCaching() > 0) {<a name="line.142"></a>
-<span class="sourceLineNo">143</span> this.caching = this.scan.getCaching();<a name="line.143"></a>
-<span class="sourceLineNo">144</span> } else {<a name="line.144"></a>
-<span class="sourceLineNo">145</span> this.caching = conf.getInt(<a name="line.145"></a>
-<span class="sourceLineNo">146</span> HConstants.HBASE_CLIENT_SCANNER_CACHING,<a name="line.146"></a>
-<span class="sourceLineNo">147</span> HConstants.DEFAULT_HBASE_CLIENT_SCANNER_CACHING);<a name="line.147"></a>
-<span class="sourceLineNo">148</span> }<a name="line.148"></a>
-<span class="sourceLineNo">149</span><a name="line.149"></a>
-<span class="sourceLineNo">150</span> this.caller = rpcFactory.<Result[]> newCaller();<a name="line.150"></a>
-<span class="sourceLineNo">151</span> this.rpcControllerFactory = controllerFactory;<a name="line.151"></a>
-<span class="sourceLineNo">152</span><a name="line.152"></a>
-<span class="sourceLineNo">153</span> this.conf = conf;<a name="line.153"></a>
-<span class="sourceLineNo">154</span> initCache();<a name="line.154"></a>
-<span class="sourceLineNo">155</span> initializeScannerInConstruction();<a name="line.155"></a>
-<span class="sourceLineNo">156</span> }<a name="line.156"></a>
+<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.CellComparator;<a name="line.25"></a>
+<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.CellUtil;<a name="line.26"></a>
+<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.DoNotRetryIOException;<a name="line.27"></a>
+<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.HBaseConfiguration;<a name="line.28"></a>
+<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.HConstants;<a name="line.29"></a>
+<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.HRegionInfo;<a name="line.30"></a>
+<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.NotServingRegionException;<a name="line.31"></a>
+<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.TableName;<a name="line.32"></a>
+<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.UnknownScannerException;<a name="line.33"></a>
+<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.classification.InterfaceAudience;<a name="line.34"></a>
+<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.exceptions.OutOfOrderScannerNextException;<a name="line.35"></a>
+<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.ipc.RpcControllerFactory;<a name="line.36"></a>
+<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.protobuf.ProtobufUtil;<a name="line.37"></a>
+<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.protobuf.generated.MapReduceProtos;<a name="line.38"></a>
+<span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.regionserver.RegionServerStoppedException;<a name="line.39"></a>
+<span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.40"></a>
+<span class="sourceLineNo">041</span><a name="line.41"></a>
+<span class="sourceLineNo">042</span>import java.io.IOException;<a name="line.42"></a>
+<span class="sourceLineNo">043</span>import java.io.InterruptedIOException;<a name="line.43"></a>
+<span class="sourceLineNo">044</span>import java.util.ArrayList;<a name="line.44"></a>
+<span class="sourceLineNo">045</span>import java.util.Arrays;<a name="line.45"></a>
+<span class="sourceLineNo">046</span>import java.util.LinkedList;<a name="line.46"></a>
+<span class="sourceLineNo">047</span>import java.util.List;<a name="line.47"></a>
+<span class="sourceLineNo">048</span>import java.util.Queue;<a name="line.48"></a>
+<span class="sourceLineNo">049</span>import java.util.concurrent.ExecutorService;<a name="line.49"></a>
+<span class="sourceLineNo">050</span><a name="line.50"></a>
+<span class="sourceLineNo">051</span>/**<a name="line.51"></a>
+<span class="sourceLineNo">052</span> * Implements the scanner interface for the HBase client.<a name="line.52"></a>
+<span class="sourceLineNo">053</span> * If there are multiple regions in a table, this scanner will iterate<a name="line.53"></a>
+<span class="sourceLineNo">054</span> * through them all.<a name="line.54"></a>
+<span class="sourceLineNo">055</span> */<a name="line.55"></a>
+<span class="sourceLineNo">056</span>@InterfaceAudience.Private<a name="line.56"></a>
+<span class="sourceLineNo">057</span>public abstract class ClientScanner extends AbstractClientScanner {<a name="line.57"></a>
+<span class="sourceLineNo">058</span> private static final Log LOG = LogFactory.getLog(ClientScanner.class);<a name="line.58"></a>
+<span class="sourceLineNo">059</span> // A byte array in which all elements are the max byte, and it is used to<a name="line.59"></a>
+<span class="sourceLineNo">060</span> // construct closest front row<a name="line.60"></a>
+<span class="sourceLineNo">061</span> static byte[] MAX_BYTE_ARRAY = Bytes.createMaxByteArray(9);<a name="line.61"></a>
+<span class="sourceLineNo">062</span> protected Scan scan;<a name="line.62"></a>
+<span class="sourceLineNo">063</span> protected boolean closed = false;<a name="line.63"></a>
+<span class="sourceLineNo">064</span> // Current region scanner is against. Gets cleared if current region goes<a name="line.64"></a>
+<span class="sourceLineNo">065</span> // wonky: e.g. if it splits on us.<a name="line.65"></a>
+<span class="sourceLineNo">066</span> protected HRegionInfo currentRegion = null;<a name="line.66"></a>
+<span class="sourceLineNo">067</span> protected ScannerCallableWithReplicas callable = null;<a name="line.67"></a>
+<span class="sourceLineNo">068</span> protected Queue<Result> cache;<a name="line.68"></a>
+<span class="sourceLineNo">069</span> /**<a name="line.69"></a>
+<span class="sourceLineNo">070</span> * A list of partial results that have been returned from the server. This list should only<a name="line.70"></a>
+<span class="sourceLineNo">071</span> * contain results if this scanner does not have enough partial results to form the complete<a name="line.71"></a>
+<span class="sourceLineNo">072</span> * result.<a name="line.72"></a>
+<span class="sourceLineNo">073</span> */<a name="line.73"></a>
+<span class="sourceLineNo">074</span> protected final LinkedList<Result> partialResults = new LinkedList<Result>();<a name="line.74"></a>
+<span class="sourceLineNo">075</span> /**<a name="line.75"></a>
+<span class="sourceLineNo">076</span> * The row for which we are accumulating partial Results (i.e. the row of the Results stored<a name="line.76"></a>
+<span class="sourceLineNo">077</span> * inside partialResults). Changes to partialResultsRow and partialResults are kept in sync<a name="line.77"></a>
+<span class="sourceLineNo">078</span> * via the methods {@link #addToPartialResults(Result)} and {@link #clearPartialResults()}<a name="line.78"></a>
+<span class="sourceLineNo">079</span> */<a name="line.79"></a>
+<span class="sourceLineNo">080</span> protected byte[] partialResultsRow = null;<a name="line.80"></a>
+<span class="sourceLineNo">081</span> /**<a name="line.81"></a>
+<span class="sourceLineNo">082</span> * The last cell from a not full Row which is added to cache<a name="line.82"></a>
+<span class="sourceLineNo">083</span> */<a name="line.83"></a>
+<span class="sourceLineNo">084</span> protected Cell lastCellLoadedToCache = null;<a name="line.84"></a>
+<span class="sourceLineNo">085</span> protected final int caching;<a name="line.85"></a>
+<span class="sourceLineNo">086</span> protected long lastNext;<a name="line.86"></a>
+<span class="sourceLineNo">087</span> // Keep lastResult returned successfully in case we have to reset scanner.<a name="line.87"></a>
+<span class="sourceLineNo">088</span> protected Result lastResult = null;<a name="line.88"></a>
+<span class="sourceLineNo">089</span> protected final long maxScannerResultSize;<a name="line.89"></a>
+<span class="sourceLineNo">090</span> private final ClusterConnection connection;<a name="line.90"></a>
+<span class="sourceLineNo">091</span> private final TableName tableName;<a name="line.91"></a>
+<span class="sourceLineNo">092</span> protected final int scannerTimeout;<a name="line.92"></a>
+<span class="sourceLineNo">093</span> protected boolean scanMetricsPublished = false;<a name="line.93"></a>
+<span class="sourceLineNo">094</span> protected RpcRetryingCaller<Result []> caller;<a name="line.94"></a>
+<span class="sourceLineNo">095</span> protected RpcControllerFactory rpcControllerFactory;<a name="line.95"></a>
+<span class="sourceLineNo">096</span> protected Configuration conf;<a name="line.96"></a>
+<span class="sourceLineNo">097</span> //The timeout on the primary. Applicable if there are multiple replicas for a region<a name="line.97"></a>
+<span class="sourceLineNo">098</span> //In that case, we will only wait for this much timeout on the primary before going<a name="line.98"></a>
+<span class="sourceLineNo">099</span> //to the replicas and trying the same scan. Note that the retries will still happen<a name="line.99"></a>
+<span class="sourceLineNo">100</span> //on each replica and the first successful results will be taken. A timeout of 0 is<a name="line.100"></a>
+<span class="sourceLineNo">101</span> //disallowed.<a name="line.101"></a>
+<span class="sourceLineNo">102</span> protected final int primaryOperationTimeout;<a name="line.102"></a>
+<span class="sourceLineNo">103</span> private int retries;<a name="line.103"></a>
+<span class="sourceLineNo">104</span> protected final ExecutorService pool;<a name="line.104"></a>
+<span class="sourceLineNo">105</span><a name="line.105"></a>
+<span class="sourceLineNo">106</span> /**<a name="line.106"></a>
+<span class="sourceLineNo">107</span> * Create a new ClientScanner for the specified table Note that the passed {@link Scan}'s start<a name="line.107"></a>
+<span class="sourceLineNo">108</span> * row maybe changed changed.<a name="line.108"></a>
+<span class="sourceLineNo">109</span> * @param conf The {@link Configuration} to use.<a name="line.109"></a>
+<span class="sourceLineNo">110</span> * @param scan {@link Scan} to use in this scanner<a name="line.110"></a>
+<span class="sourceLineNo">111</span> * @param tableName The table that we wish to scan<a name="line.111"></a>
+<span class="sourceLineNo">112</span> * @param connection Connection identifying the cluster<a name="line.112"></a>
+<span class="sourceLineNo">113</span> * @throws IOException<a name="line.113"></a>
+<span class="sourceLineNo">114</span> */<a name="line.114"></a>
+<span class="sourceLineNo">115</span> public ClientScanner(final Configuration conf, final Scan scan, final TableName tableName,<a name="line.115"></a>
+<span class="sourceLineNo">116</span> ClusterConnection connection, RpcRetryingCallerFactory rpcFactory,<a name="line.116"></a>
+<span class="sourceLineNo">117</span> RpcControllerFactory controllerFactory, ExecutorService pool, int primaryOperationTimeout)<a name="line.117"></a>
+<span class="sourceLineNo">118</span> throws IOException {<a name="line.118"></a>
+<span class="sourceLineNo">119</span> if (LOG.isTraceEnabled()) {<a name="line.119"></a>
+<span class="sourceLineNo">120</span> LOG.trace("Scan table=" + tableName<a name="line.120"></a>
+<span class="sourceLineNo">121</span> + ", startRow=" + Bytes.toStringBinary(scan.getStartRow()));<a name="line.121"></a>
+<span class="sourceLineNo">122</span> }<a name="line.122"></a>
+<span class="sourceLineNo">123</span> this.scan = scan;<a name="line.123"></a>
+<span class="sourceLineNo">124</span> this.tableName = tableName;<a name="line.124"></a>
+<span class="sourceLineNo">125</span> this.lastNext = System.currentTimeMillis();<a name="line.125"></a>
+<span class="sourceLineNo">126</span> this.connection = connection;<a name="line.126"></a>
+<span class="sourceLineNo">127</span> this.pool = pool;<a name="line.127"></a>
+<span class="sourceLineNo">128</span> this.primaryOperationTimeout = primaryOperationTimeout;<a name="line.128"></a>
+<span class="sourceLineNo">129</span> this.retries = conf.getInt(HConstants.HBASE_CLIENT_RETRIES_NUMBER,<a name="line.129"></a>
+<span class="sourceLineNo">130</span> HConstants.DEFAULT_HBASE_CLIENT_RETRIES_NUMBER);<a name="line.130"></a>
+<span class="sourceLineNo">131</span> if (scan.getMaxResultSize() > 0) {<a name="line.131"></a>
+<span class="sourceLineNo">132</span> this.maxScannerResultSize = scan.getMaxResultSize();<a name="line.132"></a>
+<span class="sourceLineNo">133</span> } else {<a name="line.133"></a>
+<span class="sourceLineNo">134</span> this.maxScannerResultSize = conf.getLong(<a name="line.134"></a>
+<span class="sourceLineNo">135</span> HConstants.HBASE_CLIENT_SCANNER_MAX_RESULT_SIZE_KEY,<a name="line.135"></a>
+<span class="sourceLineNo">136</span> HConstants.DEFAULT_HBASE_CLIENT_SCANNER_MAX_RESULT_SIZE);<a name="line.136"></a>
+<span class="sourceLineNo">137</span> }<a name="line.137"></a>
+<span class="sourceLineNo">138</span> this.scannerTimeout = HBaseConfiguration.getInt(conf,<a name="line.138"></a>
+<span class="sourceLineNo">139</span> HConstants.HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD,<a name="line.139"></a>
+<span class="sourceLineNo">140</span> HConstants.HBASE_REGIONSERVER_LEASE_PERIOD_KEY,<a name="line.140"></a>
+<span class="sourceLineNo">141</span> HConstants.DEFAULT_HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD);<a name="line.141"></a>
+<span class="sourceLineNo">142</span><a name="line.142"></a>
+<span class="sourceLineNo">143</span> // check if application wants to collect scan metrics<a name="line.143"></a>
+<span class="sourceLineNo">144</span> initScanMetrics(scan);<a name="line.144"></a>
+<span class="sourceLineNo">145</span><a name="line.145"></a>
+<span class="sourceLineNo">146</span> // Use the caching from the Scan. If not set, use the default cache setting for this table.<a name="line.146"></a>
+<span class="sourceLineNo">147</span> if (this.scan.getCaching() > 0) {<a name="line.147"></a>
+<span class="sourceLineNo">148</span> this.caching = this.scan.getCaching();<a name="line.148"></a>
+<span class="sourceLineNo">149</span> } else {<a name="line.149"></a>
+<span class="sourceLineNo">150</span> this.caching = conf.getInt(<a name="line.150"></a>
+<span class="sourceLineNo">151</span> HConstants.HBASE_CLIENT_SCANNER_CACHING,<a name="line.151"></a>
+<span class="sourceLineNo">152</span> HConstants.DEFAULT_HBASE_CLIENT_SCANNER_CACHING);<a name="line.152"></a>
+<span class="sourceLineNo">153</span> }<a name="line.153"></a>
+<span class="sourceLineNo">154</span><a name="line.154"></a>
+<span class="sourceLineNo">155</span> this.caller = rpcFactory.<Result[]> newCaller();<a name="line.155"></a>
+<span class="sourceLineNo">156</span> this.rpcControllerFactory = controllerFactory;<a name="line.156"></a>
<span class="sourceLineNo">157</span><a name="line.157"></a>
-<span class="sourceLineNo">158</span> protected abstract void initCache();<a name="line.158"></a>
-<span class="sourceLineNo">159</span><a name="line.159"></a>
-<span class="sourceLineNo">160</span> protected void initializeScannerInConstruction() throws IOException{<a name="line.160"></a>
-<span class="sourceLineNo">161</span> // initialize the scanner<a name="line.161"></a>
-<span class="sourceLineNo">162</span> nextScanner(this.caching, false);<a name="line.162"></a>
-<span class="sourceLineNo">163</span> }<a name="line.163"></a>
+<span class="sourceLineNo">158</span> this.conf = conf;<a name="line.158"></a>
+<span class="sourceLineNo">159</span> initCache();<a name="line.159"></a>
+<span class="sourceLineNo">160</span> initializeScannerInConstruction();<a name="line.160"></a>
+<span class="sourceLineNo">161</span> }<a name="line.161"></a>
+<span class="sourceLineNo">162</span><a name="line.162"></a>
+<span class="sourceLineNo">163</span> protected abstract void initCache();<a name="line.163"></a>
<span class="sourceLineNo">164</span><a name="line.164"></a>
-<span class="sourceLineNo">165</span> protected ClusterConnection getConnection() {<a name="line.165"></a>
-<span class="sourceLineNo">166</span> return this.connection;<a name="line.166"></a>
-<span class="sourceLineNo">167</span> }<a name="line.167"></a>
-<span class="sourceLineNo">168</span><a name="line.168"></a>
-<span class="sourceLineNo">169</span> protected TableName getTable() {<a name="line.169"></a>
-<span class="sourceLineNo">170</span> return this.tableName;<a name="line.170"></a>
-<span class="sourceLineNo">171</span> }<a name="line.171"></a>
-<span class="sourceLineNo">172</span><a name="line.172"></a>
-<span class="sourceLineNo">173</span> protected int getRetries() {<a name="line.173"></a>
-<span class="sourceLineNo">174</span> return this.retries;<a name="line.174"></a>
-<span class="sourceLineNo">175</span> }<a name="line.175"></a>
-<span class="sourceLineNo">176</span><a name="line.176"></a>
-<span class="sourceLineNo">177</span> protected int getScannerTimeout() {<a name="line.177"></a>
-<span class="sourceLineNo">178</span> return this.scannerTimeout;<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> protected Configuration getConf() {<a name="line.181"></a>
-<span class="sourceLineNo">182</span> return this.conf;<a name="line.182"></a>
-<span class="sourceLineNo">183</span> }<a name="line.183"></a>
-<span class="sourceLineNo">184</span><a name="line.184"></a>
-<span class="sourceLineNo">185</span> protected Scan getScan() {<a name="line.185"></a>
-<span class="sourceLineNo">186</span> return scan;<a name="line.186"></a>
-<span class="sourceLineNo">187</span> }<a name="line.187"></a>
-<span class="sourceLineNo">188</span><a name="line.188"></a>
-<span class="sourceLineNo">189</span> protected ExecutorService getPool() {<a name="line.189"></a>
-<span class="sourceLineNo">190</span> return pool;<a name="line.190"></a>
-<span class="sourceLineNo">191</span> }<a name="line.191"></a>
-<span class="sourceLineNo">192</span><a name="line.192"></a>
-<span class="sourceLineNo">193</span> protected int getPrimaryOperationTimeout() {<a name="line.193"></a>
-<span class="sourceLineNo">194</span> return primaryOperationTimeout;<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> protected int getCaching() {<a name="line.197"></a>
-<span class="sourceLineNo">198</span> return caching;<a name="line.198"></a>
-<span class="sourceLineNo">199</span> }<a name="line.199"></a>
-<span class="sourceLineNo">200</span><a name="line.200"></a>
-<span class="sourceLineNo">201</span> protected long getTimestamp() {<a name="line.201"></a>
-<span class="sourceLineNo">202</span> return lastNext;<a name="line.202"></a>
-<span class="sourceLineNo">203</span> }<a name="line.203"></a>
-<span class="sourceLineNo">204</span><a name="line.204"></a>
-<span class="sourceLineNo">205</span> @VisibleForTesting<a name="line.205"></a>
-<span class="sourceLineNo">206</span> protected long getMaxResultSize() {<a name="line.206"></a>
-<span class="sourceLineNo">207</span> return maxScannerResultSize;<a name="line.207"></a>
+<span class="sourceLineNo">165</span> protected void initializeScannerInConstruction() throws IOException{<a name="line.165"></a>
+<span class="sourceLineNo">166</span> // initialize the scanner<a name="line.166"></a>
+<span class="sourceLineNo">167</span> nextScanner(this.caching, false);<a name="line.167"></a>
+<span class="sourceLineNo">168</span> }<a name="line.168"></a>
+<span class="sourceLineNo">169</span><a name="line.169"></a>
+<span class="sourceLineNo">170</span> protected ClusterConnection getConnection() {<a name="line.170"></a>
+<span class="sourceLineNo">171</span> return this.connection;<a name="line.171"></a>
+<span class="sourceLineNo">172</span> }<a name="line.172"></a>
+<span class="sourceLineNo">173</span><a name="line.173"></a>
+<span class="sourceLineNo">174</span> protected TableName getTable() {<a name="line.174"></a>
+<span class="sourceLineNo">175</span> return this.tableName;<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> protected int getRetries() {<a name="line.178"></a>
+<span class="sourceLineNo">179</span> return this.retries;<a name="line.179"></a>
+<span class="sourceLineNo">180</span> }<a name="line.180"></a>
+<span class="sourceLineNo">181</span><a name="line.181"></a>
+<span class="sourceLineNo">182</span> protected int getScannerTimeout() {<a name="line.182"></a>
+<span class="sourceLineNo">183</span> return this.scannerTimeout;<a name="line.183"></a>
+<span class="sourceLineNo">184</span> }<a name="line.184"></a>
+<span class="sourceLineNo">185</span><a name="line.185"></a>
+<span class="sourceLineNo">186</span> protected Configuration getConf() {<a name="line.186"></a>
+<span class="sourceLineNo">187</span> return this.conf;<a name="line.187"></a>
+<span class="sourceLineNo">188</span> }<a name="line.188"></a>
+<span class="sourceLineNo">189</span><a name="line.189"></a>
+<span class="sourceLineNo">190</span> protected Scan getScan() {<a name="line.190"></a>
+<span class="sourceLineNo">191</span> return scan;<a name="line.191"></a>
+<span class="sourceLineNo">192</span> }<a name="line.192"></a>
+<span class="sourceLineNo">193</span><a name="line.193"></a>
+<span class="sourceLineNo">194</span> protected ExecutorService getPool() {<a name="line.194"></a>
+<span class="sourceLineNo">195</span> return pool;<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> protected int getPrimaryOperationTimeout() {<a name="line.198"></a>
+<span class="sourceLineNo">199</span> return primaryOperationTimeout;<a name="line.199"></a>
+<span class="sourceLineNo">200</span> }<a name="line.200"></a>
+<span class="sourceLineNo">201</span><a name="line.201"></a>
+<span class="sourceLineNo">202</span> protected int getCaching() {<a name="line.202"></a>
+<span class="sourceLineNo">203</span> return caching;<a name="line.203"></a>
+<span class="sourceLineNo">204</span> }<a name="line.204"></a>
+<span class="sourceLineNo">205</span><a name="line.205"></a>
+<span class="sourceLineNo">206</span> protected long getTimestamp() {<a name="line.206"></a>
+<span class="sourceLineNo">207</span> return lastNext;<a name="line.207"></a>
<span class="sourceLineNo">208</span> }<a name="line.208"></a>
<span class="sourceLineNo">209</span><a name="line.209"></a>
-<span class="sourceLineNo">210</span> // returns true if the passed region endKey<a name="line.210"></a>
-<span class="sourceLineNo">211</span> protected boolean checkScanStopRow(final byte [] endKey) {<a name="line.211"></a>
-<span class="sourceLineNo">212</span> if (this.scan.getStopRow().length > 0) {<a name="line.212"></a>
-<span class="sourceLineNo">213</span> // there is a stop row, check to see if we are past it.<a name="line.213"></a>
-<span class="sourceLineNo">214</span> byte [] stopRow = scan.getStopRow();<a name="line.214"></a>
-<span class="sourceLineNo">215</span> int cmp = Bytes.compareTo(stopRow, 0, stopRow.length,<a name="line.215"></a>
-<span class="sourceLineNo">216</span> endKey, 0, endKey.length);<a name="line.216"></a>
-<span class="sourceLineNo">217</span> if (cmp <= 0) {<a name="line.217"></a>
-<span class="sourceLineNo">218</span> // stopRow <= endKey (endKey is equals to or larger than stopRow)<a name="line.218"></a>
-<span class="sourceLineNo">219</span> // This is a stop.<a name="line.219"></a>
-<span class="sourceLineNo">220</span> return true;<a name="line.220"></a>
-<span class="sourceLineNo">221</span> }<a name="line.221"></a>
-<span class="sourceLineNo">222</span> }<a name="line.222"></a>
-<span class="sourceLineNo">223</span> return false; //unlikely.<a name="line.223"></a>
-<span class="sourceLineNo">224</span> }<a name="line.224"></a>
-<span class="sourceLineNo">225</span><a name="line.225"></a>
-<span class="sourceLineNo">226</span> private boolean possiblyNextScanner(int nbRows, final boolean done) throws IOException {<a name="line.226"></a>
-<span class="sourceLineNo">227</span> // If we have just switched replica, don't go to the next scanner yet. Rather, try<a name="line.227"></a>
-<span class="sourceLineNo">228</span> // the scanner operations on the new replica, from the right point in the scan<a name="line.228"></a>
-<span class="sourceLineNo">229</span> // Note that when we switched to a different replica we left it at a point<a name="line.229"></a>
-<span class="sourceLineNo">230</span> // where we just did the "openScanner" with the appropriate startrow<a name="line.230"></a>
-<span class="sourceLineNo">231</span> if (callable != null && callable.switchedToADifferentReplica()) return true;<a name="line.231"></a>
-<span class="sourceLineNo">232</span> return nextScanner(nbRows, done);<a name="line.232"></a>
-<span class="sourceLineNo">233</span> }<a name="line.233"></a>
-<span class="sourceLineNo">234</span><a name="line.234"></a>
-<span class="sourceLineNo">235</span> /*<a name="line.235"></a>
-<span class="sourceLineNo">236</span> * Gets a scanner for the next region. If this.currentRegion != null, then<a name="line.236"></a>
-<span class="sourceLineNo">237</span> * we will move to the endrow of this.currentRegion. Else we will get<a name="line.237"></a>
-<span class="sourceLineNo">238</span> * scanner at the scan.getStartRow(). We will go no further, just tidy<a name="line.238"></a>
-<span class="sourceLineNo">239</span> * up outstanding scanners, if <code>currentRegion != null</code> and<a name="line.239"></a>
-<span class="sourceLineNo">240</span> * <code>done</code> is true.<a name="line.240"></a>
-<span class="sourceLineNo">241</span> * @param nbRows<a name="line.241"></a>
-<span class="sourceLineNo">242</span> * @param done Server-side says we're done scanning.<a name="line.242"></a>
-<span class="sourceLineNo">243</span> */<a name="line.243"></a>
-<span class="sourceLineNo">244</span> protected boolean nextScanner(int nbRows, final boolean done)<a name="line.244"></a>
-<span class="sourceLineNo">245</span> throws IOException {<a name="line.245"></a>
-<span class="sourceLineNo">246</span> // Close the previous scanner if it's open<a name="line.246"></a>
-<span class="sourceLineNo">247</span> if (this.callable != null) {<a name="line.247"></a>
-<span class="sourceLineNo">248</span> this.callable.setClose();<a name="line.248"></a>
-<span class="sourceLineNo">249</span> call(callable, caller, scannerTimeout);<a name="line.249"></a>
-<span class="sourceLineNo">250</span> this.callable = null;<a name="line.250"></a>
-<span class="sourceLineNo">251</span> }<a name="line.251"></a>
-<span class="sourceLineNo">252</span><a name="line.252"></a>
-<span class="sourceLineNo">253</span> // Where to start the next scanner<a name="line.253"></a>
-<span class="sourceLineNo">254</span> byte [] localStartKey;<a name="line.254"></a>
-<span class="sourceLineNo">255</span><a name="line.255"></a>
-<span class="sourceLineNo">256</span> // if we're at end of table, close and return false to stop iterating<a name="line.256"></a>
-<span class="sourceLineNo">257</span> if (this.currentRegion != null) {<a name="line.257"></a>
-<span class="sourceLineNo">258</span> byte [] endKey = this.currentRegion.getEndKey();<a name="line.258"></a>
-<span class="sourceLineNo">259</span> if (endKey == null ||<a name="line.259"></a>
-<span class="sourceLineNo">260</span> Bytes.equals(endKey, HConstants.EMPTY_BYTE_ARRAY) ||<a name="line.260"></a>
-<span class="sourceLineNo">261</span> checkScanStopRow(endKey) ||<a name="line.261"></a>
-<span class="sourceLineNo">262</span> done) {<a name="line.262"></a>
-<span class="sourceLineNo">263</span> close();<a name="line.263"></a>
-<span class="sourceLineNo">264</span> if (LOG.isTraceEnabled()) {<a name="line.264"></a>
-<span class="sourceLineNo">265</span> LOG.trace("Finished " + this.currentRegion);<a name="line.265"></a>
-<span class="sourceLineNo">266</span> }<a name="line.266"></a>
-<span class="sourceLineNo">267</span> return false;<a name="line.267"></a>
-<span class="sourceLineNo">268</span> }<a name="line.268"></a>
-<span class="sourceLineNo">269</span> localStartKey = endKey;<a name="line.269"></a>
-<span class="sourceLineNo">270</span> if (LOG.isTraceEnabled()) {<a name="line.270"></a>
-<span class="sourceLineNo">271</span> LOG.trace("Finished " + this.currentRegion);<a name="line.271"></a>
-<span class="sourceLineNo">272</span> }<a name="line.272"></a>
-<span class="sourceLineNo">273</span> } else {<a name="line.273"></a>
-<span class="sourceLineNo">274</span> localStartKey = this.scan.getStartRow();<a name="line.274"></a>
-<span class="sourceLineNo">275</span> }<a name="line.275"></a>
-<span class="sourceLineNo">276</span><a name="line.276"></a>
-<span class="sourceLineNo">277</span> if (LOG.isDebugEnabled() && this.currentRegion != null) {<a name="line.277"></a>
-<span class="sourceLineNo">278</span> // Only worth logging if NOT first region in scan.<a name="line.278"></a>
-<span class="sourceLineNo">279</span> LOG.debug("Advancing internal scanner to startKey at '" +<a name="line.279"></a>
-<span class="sourceLineNo">280</span> Bytes.toStringBinary(localStartKey) + "'");<a name="line.280"></a>
-<span class="sourceLineNo">281</span> }<a name="line.281"></a>
-<span class="sourceLineNo">282</span> try {<a name="line.282"></a>
-<span class="sourceLineNo">283</span> callable = getScannerCallable(localStartKey, nbRows);<a name="line.283"></a>
-<span class="sourceLineNo">284</span> // Open a scanner on the region server starting at the<a name="line.284"></a>
-<span class="sourceLineNo">285</span> // beginning of the region<a name="line.285"></a>
-<span class="sourceLineNo">286</span> call(callable, caller, scannerTimeout);<a name="line.286"></a>
-<span class="sourceLineNo">287</span> this.currentRegion = callable.getHRegionInfo();<a name="line.287"></a>
-<span class="sourceLineNo">288</span> if (this.scanMetrics != null) {<a name="line.288"></a>
-<span class="sourceLineNo">289</span> this.scanMetrics.countOfRegions.incrementAndGet();<a name="line.289"></a>
-<span class="sourceLineNo">290</span> }<a name="line.290"></a>
-<span class="sourceLineNo">291</span> } catch (IOException e) {<a name="line.291"></a>
-<span class="sourceLineNo">292</span> close();<a name="line.292"></a>
-<span class="sourceLineNo">293</span> throw e;<a name="line.293"></a>
-<span class="sourceLineNo">294</span> }<a name="line.294"></a>
-<span class="sourceLineNo">295</span> return true;<a name="line.295"></a>
-<span class="sourceLineNo">296</span> }<a name="line.296"></a>
-<span class="sourceLineNo">297</span><a name="line.297"></a>
-<span class="sourceLineNo">298</span> @VisibleForTesting<a name="line.298"></a>
-<span class="sourceLineNo">299</span> boolean isAnyRPCcancelled() {<a name="line.299"></a>
-<span class="sourceLineNo">300</span> return callable.isAnyRPCcancelled();<a name="line.300"></a>
-<span class="sourceLineNo">301</span> }<a name="line.301"></a>
+<span class="sourceLineNo">210</span> @VisibleForTesting<a name="line.210"></a>
+<span class="sourceLineNo">211</span> protected long getMaxResultSize() {<a name="line.211"></a>
+<span class="sourceLineNo">212</span> return maxScannerResultSize;<a name="line.212"></a>
+<span class="sourceLineNo">213</span> }<a name="line.213"></a>
+<span class="sourceLineNo">214</span><a name="line.214"></a>
+<span class="sourceLineNo">215</span> // returns true if the passed region endKey<a name="line.215"></a>
+<span class="sourceLineNo">216</span> protected boolean checkScanStopRow(final byte [] endKey) {<a name="line.216"></a>
+<span class="sourceLineNo">217</span> if (this.scan.getStopRow().length > 0) {<a name="line.217"></a>
+<span class="sourceLineNo">218</span> // there is a stop row, check to see if we are past it.<a name="line.218"></a>
+<span class="sourceLineNo">219</span> byte [] stopRow = scan.getStopRow();<a name="line.219"></a>
+<span class="sourceLineNo">220</span> int cmp = Bytes.compareTo(stopRow, 0, stopRow.length,<a name="line.220"></a>
+<span class="sourceLineNo">221</span> endKey, 0, endKey.length);<a name="line.221"></a>
+<span class="sourceLineNo">222</span> if (cmp <= 0) {<a name="line.222"></a>
+<span class="sourceLineNo">223</span> // stopRow <= endKey (endKey is equals to or larger than stopRow)<a name="line.223"></a>
+<span class="sourceLineNo">224</span> // This is a stop.<a name="line.224"></a>
+<span class="sourceLineNo">225</span> return true;<a name="line.225"></a>
+<span class="sourceLineNo">226</span> }<a name="line.226"></a>
+<span class="sourceLineNo">227</span> }<a name="line.227"></a>
+<span class="sourceLineNo">228</span> return false; //unlikely.<a name="line.228"></a>
+<span class="sourceLineNo">229</span> }<a name="line.229"></a>
+<span class="sourceLineNo">230</span><a name="line.230"></a>
+<span class="sourceLineNo">231</span> private boolean possiblyNextScanner(int nbRows, final boolean done) throws IOException {<a name="line.231"></a>
+<span class="sourceLineNo">232</span> // If we have just switched replica, don't go to the next scanner yet. Rather, try<a name="line.232"></a>
+<span class="sourceLineNo">233</span> // the scanner operations on the new replica, from the right point in the scan<a name="line.233"></a>
+<span class="sourceLineNo">234</span> // Note that when we switched to a different replica we left it at a point<a name="line.234"></a>
+<span class="sourceLineNo">235</span> // where we just did the "openScanner" with the appropriate startrow<a name="line.235"></a>
+<span class="sourceLineNo">236</span> if (callable != null && callable.switchedToADifferentReplica()) return true;<a name="line.236"></a>
+<span class="sourceLineNo">237</span> return nextScanner(nbRows, done);<a name="line.237"></a>
+<span class="sourceLineNo">238</span> }<a name="line.238"></a>
+<span class="sourceLineNo">239</span><a name="line.239"></a>
+<span class="sourceLineNo">240</span> /*<a name="line.240"></a>
+<span class="sourceLineNo">241</span> * Gets a scanner for the next region. If this.currentRegion != null, then<a name="line.241"></a>
+<span class="sourceLineNo">242</span> * we will move to the endrow of this.currentRegion. Else we will get<a name="line.242"></a>
+<span class="sourceLineNo">243</span> * scanner at the scan.getStartRow(). We will go no further, just tidy<a name="line.243"></a>
+<span class="sourceLineNo">244</span> * up outstanding scanners, if <code>currentRegion != null</code> and<a name="line.244"></a>
+<span class="sourceLineNo">245</span> * <code>done</code> is true.<a name="line.245"></a>
+<span class="sourceLineNo">246</span> * @param nbRows<a name="line.246"></a>
+<span class="sourceLineNo">247</span> * @param done Server-side says we're done scanning.<a name="line.247"></a>
+<span class="sourceLineNo">248</span> */<a name="line.248"></a>
+<span class="sourceLineNo">249</span> protected boolean nextScanner(int nbRows, final boolean done)<a name="line.249"></a>
+<span class="sourceLineNo">250</span> throws IOException {<a name="line.250"></a>
+<span class="sourceLineNo">251</span> // Close the previous scanner if it's open<a name="line.251"></a>
+<span class="sourceLineNo">252</span> if (this.callable != null) {<a name="line.252"></a>
+<span class="sourceLineNo">253</span> this.callable.setClose();<a name="line.253"></a>
+<span class="sourceLineNo">254</span> call(callable, caller, scannerTimeout);<a name="line.254"></a>
+<span class="sourceLineNo">255</span> this.callable = null;<a name="line.255"></a>
+<span class="sourceLineNo">256</span> }<a name="line.256"></a>
+<span class="sourceLineNo">257</span><a name="line.257"></a>
+<span class="sourceLineNo">258</span> // Where to start the next scanner<a name="line.258"></a>
+<span class="sourceLineNo">259</span> byte [] localStartKey;<a name="line.259"></a>
+<span class="sourceLineNo">260</span><a name="line.260"></a>
+<span class="sourceLineNo">261</span> // if we're at end of table, close and return false to stop iterating<a name="line.261"></a>
+<span class="sourceLineNo">262</span> if (this.currentRegion != null) {<a name="line.262"></a>
+<span class="sourceLineNo">263</span> byte [] endKey = this.currentRegion.getEndKey();<a name="line.263"></a>
+<span class="sourceLineNo">264</span> if (endKey == null ||<a name="line.264"></a>
+<span class="sourceLineNo">265</span> Bytes.equals(endKey, HConstants.EMPTY_BYTE_ARRAY) ||<a name="line.265"></a>
+<span class="sourceLineNo">266</span> checkScanStopRow(endKey) ||<a name="line.266"></a>
+<span class="sourceLineNo">267</span> done) {<a name="line.267"></a>
+<span class="sourceLineNo">268</span> close();<a name="line.268"></a>
+<span class="sourceLineNo">269</span> if (LOG.isTraceEnabled()) {<a name="line.269"></a>
+<span class="sourceLineNo">270</span> LOG.trace("Finished " + this.currentRegion);<a name="line.270"></a>
+<span class="sourceLineNo">271</span> }<a name="line.271"></a>
+<span class="sourceLineNo">272</span> return false;<a name="line.272"></a>
+<span class="sourceLineNo">273</span> }<a name="line.273"></a>
+<span class="sourceLineNo">274</span> localStartKey = endKey;<a name="line.274"></a>
+<span class="sourceLineNo">275</span> if (LOG.isTraceEnabled()) {<a name="line.275"></a>
+<span class="sourceLineNo">276</span> LOG.trace("Finished " + this.currentRegion);<a name="line.276"></a>
+<span class="sourceLineNo">277</span> }<a name="line.277"></a>
+<span class="sourceLineNo">278</span> } else {<a name="line.278"></a>
+<span class="sourceLineNo">279</span> localStartKey = this.scan.getStartRow();<a name="line.279"></a>
+<span class="sourceLineNo">280</span> }<a name="line.280"></a>
+<span class="sourceLineNo">281</span><a name="line.281"></a>
+<span class="sourceLineNo">282</span> if (LOG.isDebugEnabled() && this.currentRegion != null) {<a name="line.282"></a>
+<span class="sourceLineNo">283</span> // Only worth logging if NOT first region in scan.<a name="line.283"></a>
+<span class="sourceLineNo">284</span> LOG.debug("Advancing internal scanner to startKey at '" +<a name="line.284"></a>
+<span class="sourceLineNo">285</span> Bytes.toStringBinary(localStartKey) + "'");<a name="line.285"></a>
+<span class="sourceLineNo">286</span> }<a name="line.286"></a>
+<span class="sourceLineNo">287</span> try {<a name="line.287"></a>
+<span class="sourceLineNo">288</span> callable = getScannerCallable(localStartKey, nbRows);<a name="line.288"></a>
+<span class="sourceLineNo">289</span> // Open a scanner on the region server starting at the<a name="line.289"></a>
+<span class="sourceLineNo">290</span> // beginning of the region<a name="line.290"></a>
+<span class="sourceLineNo">291</span> call(callable, caller, scannerTimeout);<a name="line.291"></a>
+<span class="sourceLineNo">292</span> this.currentRegion = callable.getHRegionInfo();<a name="line.292"></a>
+<span class="sourceLineNo">293</span> if (this.scanMetrics != null) {<a name="line.293"></a>
+<span class="sourceLineNo">294</span> this.scanMetrics.countOfRegions.incrementAndGet();<a name="line.294"></a>
+<span class="sourceLineNo">295</span> }<a name="line.295"></a>
+<span class="sourceLineNo">296</span> } catch (IOException e) {<a name="line.296"></a>
+<span class="sourceLineNo">297</span> close();<a name="line.297"></a>
+<span class="sourceLineNo">298</span> throw e;<a name="line.298"></a>
+<span class="sourceLineNo">299</span> }<a name="line.299"></a>
+<span class="sourceLineNo">300</span> return true;<a name="line.300"></a>
+<span class="sourceLineNo">301</span> }<a name="line.301"></a>
<span class="sourceLineNo">302</span><a name="line.302"></a>
-<span class="sourceLineNo">303</span> Result[] call(ScannerCallableWithReplicas callable,<a name="line.303"></a>
-<span class="sourceLineNo">304</span> RpcRetryingCaller<Result[]> caller, int scannerTimeout)<a name="line.304"></a>
-<span class="sourceLineNo">305</span> throws IOException, RuntimeException {<a name="line.305"></a>
-<span class="sourceLineNo">306</span> if (Thread.interrupted()) {<a name="line.306"></a>
-<span class="sourceLineNo">307</span> throw new InterruptedIOException();<a name="line.307"></a>
-<span class="sourceLineNo">308</span> }<a name="line.308"></a>
-<span class="sourceLineNo">309</span> // callWithoutRetries is at this layer. Within the ScannerCallableWithReplicas,<a name="line.309"></a>
-<span class="sourceLineNo">310</span> // we do a callWithRetries<a name="line.310"></a>
-<span class="sourceLineNo">311</span> return caller.callWithoutRetries(callable, scannerTimeout);<a name="line.311"></a>
-<span class="sourceLineNo">312</span> }<a name="line.312"></a>
-<span class="sourceLineNo">313</span><a name="line.313"></a>
-<span class="sourceLineNo">314</span> @InterfaceAudience.Private<a name="line.314"></a>
-<span class="sourceLineNo">315</span> protected ScannerCallableWithReplicas getScannerCallable(byte [] localStartKey,<a name="line.315"></a>
-<span class="sourceLineNo">316</span> int nbRows) {<a name="line.316"></a>
-<span class="sourceLineNo">317</span> scan.setStartRow(localStartKey);<a name="line.317"></a>
-<span class="sourceLineNo">318</span> ScannerCallable s =<a name="line.318"></a>
-<span class="sourceLineNo">319</span> new ScannerCallable(getConnection(), getTable(), scan, this.scanMetrics,<a name="line.319"></a>
-<span class="sourceLineNo">320</span> this.rpcControllerFactory);<a name="line.320"></a>
-<span class="sourceLineNo">321</span> s.setCaching(nbRows);<a name="line.321"></a>
-<span class="sourceLineNo">322</span> ScannerCallableWithReplicas sr = new ScannerCallableWithReplicas(tableName, getConnection(),<a name="line.322"></a>
-<span class="sourceLineNo">323</span> s, pool, primaryOperationTimeout, scan,<a name="line.323"></a>
-<span class="sourceLineNo">324</span> retries, scannerTimeout, caching, conf, caller);<a name="line.324"></a>
-<span class="sourceLineNo">325</span> return sr;<a name="line.325"></a>
-<span class="sourceLineNo">326</span> }<a name="line.326"></a>
-<span class="sourceLineNo">327</span><a name="line.327"></a>
-<span class="sourceLineNo">328</span> /**<a name="line.328"></a>
-<span class="sourceLineNo">329</span> * Publish the scan metrics. For now, we use scan.setAttribute to pass the metrics back to the<a name="line.329"></a>
-<span class="sourceLineNo">330</span> * application or TableInputFormat.Later, we could push it to other systems. We don't use<a name="line.330"></a>
-<span class="sourceLineNo">331</span> * metrics framework because it doesn't support multi-instances of the same metrics on the same<a name="line.331"></a>
-<span class="sourceLineNo">332</span> * machine; for scan/map reduce scenarios, we will have multiple scans running at the same time.<a name="line.332"></a>
-<span class="sourceLineNo">333</span> *<a name="line.333"></a>
-<span class="sourceLineNo">334</span> * By default, scan metrics are disabled; if the application wants to collect them, this<a name="line.334"></a>
-<span class="sourceLineNo">335</span> * behavior can be turned on by calling calling {@link Scan#setScanMetricsEnabled(boolean)}<a name="line.335"></a>
-<span class="sourceLineNo">336</span> *<a name="line.336"></a>
-<span class="sourceLineNo">337</span> * <p>This invocation clears the scan metrics. Metrics are aggregated in the Scan instance.<a name="line.337"></a>
-<span class="sourceLineNo">338</span> */<a name="line.338"></a>
-<span class="sourceLineNo">339</span> protected void writeScanMetrics() {<a name="line.339"></a>
-<span class="sourceLineNo">340</span> if (this.scanMetrics == null || scanMetricsPublished) {<a name="line.340"></a>
-<span class="sourceLineNo">341</span> return;<a name="line.341"></a>
-<span class="sourceLineNo">342</span> }<a name="line.342"></a>
-<span class="sourceLineNo">343</span> MapReduceProtos.ScanMetrics pScanMetrics = ProtobufUtil.toScanMetrics(scanMetrics);<a name="line.343"></a>
-<span class="sourceLineNo">344</span> scan.setAttribute(Scan.SCAN_ATTRIBUTES_METRICS_DATA, pScanMetrics.toByteArray());<a name="line.344"></a>
-<span class="sourceLineNo">345</span> scanMetricsPublished = true;<a name="line.345"></a>
-<span class="sourceLineNo">346</span> }<a name="line.346"></a>
-<span class="sourceLineNo">347</span><a name="line.347"></a>
-<span class="sourceLineNo">348</span> protected void initSyncCache() {<a name="line.348"></a>
-<span class="sourceLineNo">349</span> cache = new LinkedList<Result>();<a name="line.349"></a>
-<span class="sourceLineNo">350</span> }<a name="line.350"></a>
-<span class="sourceLineNo">351</span><a name="line.351"></a>
-<span class="sourceLineNo">352</span> protected Result nextWithSyncCache() throws IOException {<a name="line.352"></a>
-<span class="sourceLineNo">353</span> // If the scanner is closed and there's nothing left in the cache, next is a no-op.<a name="line.353"></a>
-<span class="sourceLineNo">354</span> if (cache.size() == 0 && this.closed) {<a name="line.354"></a>
-<span class="sourceLineNo">355</span> return null;<a name="line.355"></a>
-<span class="sourceLineNo">356</span> }<a name="line.356"></a>
-<span class="sourceLineNo">357</span> if (cache.size() == 0) {<a name="line.357"></a>
-<span class="sourceLineNo">358</span> loadCache();<a name="line.358"></a>
-<span class="sourceLineNo">359</span> }<a name="line.359"></a>
-<span class="sourceLineNo">360</span><a name="line.360"></a>
-<span class="sourceLineNo">361</span> if (cache.size() > 0) {<a name="line.361"></a>
-<span class="sourceLineNo">362</span> return cache.poll();<a name="line.362"></a>
-<span class="sourceLineNo">363</span> }<a name="line.363"></a>
-<span class="sourceLineNo">364</span><a name="line.364"></a>
-<span class="sourceLineNo">365</span> // if we exhausted this scanner before calling close, write out the scan metrics<a name="line.365"></a>
-<span class="sourceLineNo">366</span> writeScanMetrics();<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">303</span> @VisibleForTesting<a name="line.303"></a>
+<span class="sourceLineNo">304</span> boolean isAnyRPCcancelled() {<a name="line.304"></a>
+<span class="sourceLineNo">305</span> return callable.isAnyRPCcancelled();<a name="line.305"></a>
+<span class="sourceLineNo">306</span> }<a name="line.306"></a>
+<span class="sourceLineNo">307</span><a name="line.307"></a>
+<span class="sourceLineNo">308</span> Result[] call(ScannerCallableWithReplicas callable,<a name="line.308"></a>
+<span class="sourceLineNo">309</span> RpcRetryingCaller<Result[]> caller, int scannerTimeout)<a name="line.309"></a>
+<span class="sourceLineNo">310</span> throws IOException, RuntimeException {<a name="line.310"></a>
+<span class="sourceLineNo">311</span> if (Thread.interrupted()) {<a name="line.311"></a>
+<span class="sourceLineNo">312</span> throw new InterruptedIOException();<a name="line.312"></a>
+<span class="sourceLineNo">313</span> }<a name="line.313"></a>
+<span class="sourceLineNo">314</span> // callWithoutRetries is at this layer. Within the ScannerCallableWithReplicas,<a name="line.314"></a>
+<span class="sourceLineNo">315</span> // we do a callWithRetries<a name="line.315"></a>
+<span class="sourceLineNo">316</span> return caller.callWithoutRetries(callable, scannerTimeout);<a name="line.316"></a>
+<span class="sourceLineNo">317</span> }<a name="line.317"></a>
+<span class="sourceLineNo">318</span><a name="line.318"></a>
+<span class="sourceLineNo">319</span> @InterfaceAudience.Private<a name="line.319"></a>
+<span class="sourceLineNo">320</span> protected ScannerCallableWithReplicas getScannerCallable(byte [] localStartKey,<a name="line.320"></a>
+<span class="sourceLineNo">321</span> int nbRows) {<a name="line.321"></a>
+<span class="sourceLineNo">322</span> scan.setStartRow(localStartKey);<a name="line.322"></a>
+<span class="sourceLineNo">323</span> ScannerCallable s =<a name="line.323"></a>
+<span class="sourceLineNo">324</span> new ScannerCallable(getConnection(), getTable(), scan, this.scanMetrics,<a name="line.324"></a>
+<span class="sourceLineNo">325</span> this.rpcControllerFactory);<a name="line.325"></a>
+<span class="sourceLineNo">326</span> s.setCaching(nbRows);<a name="line.326"></a>
+<span class="sourceLineNo">327</span> ScannerCallableWithReplicas sr = new ScannerCallableWithReplicas(tableName, getConnection(),<a name="line.327"></a>
+<span class="sourceLineNo">328</span> s, pool, primaryOperationTimeout, scan,<a name="line.328"></a>
+<span class="sourceLineNo">329</span> retries, scannerTimeout, caching, conf, caller);<a name="line.329"></a>
+<span class="sourceLineNo">330</span> return sr;<a name="line.330"></a>
+<span class="sourceLineNo">331</span> }<a name="line.331"></a>
+<span class="sourceLineNo">332</span><a name="line.332"></a>
+<span class="sourceLineNo">333</span> /**<a name="line.333"></a>
+<span class="sourceLineNo">334</span> * Publish the scan metrics. For now, we use scan.setAttribute to pass the metrics back to the<a name="line.334"></a>
+<span class="sourceLineNo">335</span> * application or TableInputFormat.Later, we could push it to other systems. We don't use<a name="line.335"></a>
+<span class="sourceLineNo">336</span> * metrics framework because it doesn't support multi-instances of the same metrics on the same<a name="line.336"></a>
+<span class="sourceLineNo">337</span> * machine; for scan/map reduce scenarios, we will have multiple scans running at the same time.<a name="line.337"></a>
+<span class="sourceLineNo">338</span> *<a name="line.338"></a>
+<span class="sourceLineNo">339</span> * By default, scan metrics are disabled; if the application wants to collect them, this<a name="line.339"></a>
+<span class="sourceLineNo">340</span> * behavior can be turned on by calling calling {@link Scan#setScanMetricsEnabled(boolean)}<a name="line.340"></a>
+<span class="sourceLineNo">341</span> *<a name="line.341"></a>
+<span class="sourceLineNo">342</span> * <p>This invocation clears the scan metrics. Metrics are aggregated in the Scan instance.<a name="line.342"></a>
+<span class="sourceLineNo">343</span> */<a name="line.343"></a>
+<span class="sourceLineNo">344</span> protected void writeScanMetrics() {<a name="line.344"></a>
+<span class="sourceLineNo">345</span> if (this.scanMetrics == null || scanMetricsPublished) {<a name="line.345"></a>
+<span class="sourceLineNo">346</span> return;<a name="line.346"></a>
+<span class="sourceLineNo">347</span> }<a name="line.347"></a>
+<span class="sourceLineNo">348</span> MapReduceProtos.ScanMetrics pScanMetrics = ProtobufUtil.toScanMetrics(scanMetrics);<a name="line.348"></a>
+<span class="sourceLineNo">349</span> scan.setAttribute(Scan.SCAN_ATTRIBUTES_METRICS_DATA, pScanMetrics.toByteArray());<a name="line.349"></a>
+<span class="sourceLineNo">350</span> scanMetricsPublished = true;<a name="line.350"></a>
+<span class="sourceLineNo">351</span> }<a name="line.351"></a>
+<span class="sourceLineNo">352</span><a name="line.352"></a>
+<span class="sourceLineNo">353</span> protected void initSyncCache() {<a name="line.353"></a>
+<span class="sourceLineNo">354</span> cache = new LinkedList<Result>();<a name="line.354"></a>
+<span class="sourceLineNo">355</span> }<a name="line.355"></a>
+<span class="sourceLineNo">356</span><a name="line.356"></a>
+<span class="sourceLineNo">357</span> protected Result nextWithSyncCache() throws IOException {<a name="line.357"></a>
+<span class="sourceLineNo">358</span> // If the scanner is closed and there's nothing left in the cache, next is a no-op.<a name="line.358"></a>
+<span class="sourceLineNo">359</span> if (cache.size() == 0 && this.closed) {<a name="line.359"></a>
+<span class="sourceLineNo">360</span> return null;<a name="line.360"></a>
+<span class="sourceLineNo">361</span> }<a name="line.361"></a>
+<span class="sourceLineNo">362</span> if (cache.size() == 0) {<a name="line.362"></a>
+<span class="sourceLineNo">363</span> loadCache();<a name="line.363"></a>
+<span class="sourceLineNo">364</span> }<a name="line.364"></a>
+<span class="sourceLineNo">365</span><a name="line.365"></a>
+<span class="sourceLineNo">366</span> if (cache.size() > 0) {<a name="line.366"></a>
+<span class="sourceLineNo">367</span> return cache.poll();<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> @VisibleForTesting<a name="line.370"></a>
-<span class="sourceLineNo">371</span> public int getCacheSize() {<a name="line.371"></a>
-<span class="sourceLineNo">372</span> return cache != null ? cache.size() : 0;<a name="line.372"></a>
-<span class="sourceLineNo">373</span> }<a name="line.373"></a>
+<span class="sourceLineNo">370</span> // if we exhausted this scanner before calling close, write out the scan metrics<a name="line.370"></a>
+<span class="sourceLineNo">371</span> writeScanMetrics();<a name="line.371"></a>
+<span class="sourceLineNo">372</span> return null;<a name="line.372"></a>
+<span class="sourceLineNo">373</span> }<a name="line.373"></a>
<span class="sourceLineNo">374</span><a name="line.374"></a>
-<span class="sourceLineNo">375</span> /**<a name="line.375"></a>
-<span class="sourceLineNo">376</span> * Contact the servers to load more {@link Result}s in the cache.<a name="line.376"></a>
-<span class="sourceLineNo">377</span> */<a name="line.377"></a>
-<span class="sourceLineNo">378</span> protected void loadCache() throws IOException {<a name="line.378"></a>
-<span class="sourceLineNo">379</span> // check if scanner was closed during previous prefetch<a name="line.379"></a>
-<span class="sourceLineNo">380</span> if (closed) return;<a name="line.380"></a>
-<span class="sourceLineNo">381</span> Result[] values = null;<a name="line.381"></a>
-<span class="sourceLineNo">382</span> long remainingResultSize = maxScannerResultSize;<a name="line.382"></a>
-<span class="sourceLineNo">383</span> int countdown = this.caching;<a name="line.383"></a>
-<span class="sourceLineNo">384</span> // We need to reset it if it's a new callable that was created with a countdown in nextScanner<a name="line.384"></a>
-<span class="sourceLineNo">385</span> callable.setCaching(this.caching);<a name="line.385"></a>
-<span class="sourceLineNo">386</span> // This flag is set when we want to skip the result returned. We do<a name="line.386"></a>
-<span class="sourceLineNo">387</span> // this when we reset scanner because it split under us.<a name="line.387"></a>
-<span class="sourceLineNo">388</span> boolean retryAfterOutOfOrderException = true;<a name="line.388"></a>
-<span class="sourceLineNo">389</span> // We don't expect that the server will have more results for us if<a name="line.389"></a>
-<span class="sourceLineNo">390</span> // it doesn't tell us otherwise. We rely on the size or count of results<a name="line.390"></a>
-<span class="sourceLineNo">391</span> boolean serverHasMoreResults = false;<a name="line.391"></a>
-<span class="sourceLineNo">392</span> do {<a name="line.392"></a>
-<span class="sourceLineNo">393</span> try {<a name="line.393"></a>
-<span class="sourceLineNo">394</span> // Server returns a null values if scanning is to stop. Else,<a name="line.394"></a>
-<span class="sourceLineNo">395</span> // returns an empty array if scanning is to go on and we've just<a name="line.395"></a>
-<span class="sourceLineNo">396</span> // exhausted current region.<a name="line.396"></a>
-<span class="sourceLineNo">397</span> values = call(callable, caller, scannerTimeout);<a name="line.397"></a>
-<span class="sourceLineNo">398</span> // When the replica switch happens, we need to do certain operations again.<a name="line.398"></a>
-<span class="sourceLineNo">399</span> // The callable will openScanner with the right startkey but we need to pick up<a name="line.399"></a>
-<span class="sourceLineNo">400</span> // from there. Bypass the rest of the loop and let the catch-up happen in the beginning<a name="line.400"></a>
-<span class="sourceLineNo">401</span> // of the loop as it happens for the cases where we see exceptions.<a name="line.401"></a>
-<span class="sourceLineNo">402</span> // Since only openScanner would have happened, values would be null<a name="line.402"></a>
-<span class="sourceLineNo">403</span> if (values == null && callable.switchedToADifferentReplica()) {<a name="line.403"></a>
-<span class="sourceLineNo">404</span> // Any accumulated partial results are no longer valid since the callable will<a name="line.404"></a>
-<span class="sourceLineNo">405</span> // openScanner with the correct startkey and we must pick up from there<a name="line.405"></a>
-<span class="sourceLineNo">406</span> clearPartialResults();<a name="line.406"></a>
-<span class="sourceLineNo">407</span> this.currentRegion = callable.getHRegionInfo();<a name="line.407"></a>
-<span class="sourceLineNo">408</span> continue;<a name="line.408"></a>
-<span class="sourceLineNo">409</span> }<a name="line.409"></a>
-<span class="sourceLineNo">410</span> retryAfterOutOfOrderException = true;<a name="line.410"></a>
-<span class="sourceLineNo">411</span> } catch (DoNotRetryIOException e) {<a name="line.411"></a>
-<span class="sourceLineNo">412</span> // An exception was thrown which makes any partial results that we were collecting<a name="line.412"></a>
-<span class="sourceLineNo">413</span> // invalid. The scanner will need to be reset to the beginning of a row.<a name="line.413"></a>
-<span class="sourceLineNo">414</span> clearPartialResults();<a name="line.414"></a>
-<span class="sourceLineNo">415</span> // DNRIOEs are thrown to make us break out of retries. Some types of DNRIOEs want us<a name="line.415"></a>
-<span class="sourceLineNo">416</span> // to reset the scanner and come back in again.<a name="line.416"></a>
-<span class="sourceLineNo">417</span> if (e instanceof UnknownScannerException) {<a name="line.417"></a>
-<span class="sourceLineNo">418</span> long timeout = lastNext + scannerTimeout;<a name="line.418"></a>
-<span class="sourceLineNo">419</span> // If we are over the timeout, throw this exception to the client wrapped in<a name="line.419"></a>
-<span class="sourceLineNo">420</span> // a ScannerTimeoutException. Else, it's because the region moved and we used the old<a name="line.420"></a>
-<span class="sourceLineNo">421</span> // id against the new region server; reset the scanner.<a name="line.421"></a>
-<span class="sourceLineNo">422</span> if (timeout < System.currentTimeMillis()) {<a name="line.422"></a>
-<span class="sourceLineNo">423</span> LOG.info("For hints related to the following exception, please try taking a look at: "<a name="line.423"></a>
-<span class="sourceLineNo">424</span> + "https://hbase.apache.org/book.html#trouble.client.scantimeout");<a name="line.424"></a>
-<span class="sourceLineNo">425</span> long elapsed = System.currentTimeMillis() - lastNext;<a name="line.425"></a>
-<span class="sourceLineNo">426</span> ScannerTimeoutException ex =<a name="line.426"></a>
-<span class="sourceLineNo">427</span> new ScannerTimeoutException(elapsed + "ms passed since the last invocation, "<a name="line.427"></a>
-<span class="sourceLineNo">428</span> + "timeout is currently set to " + scannerTimeout);<a name="line.428"></a>
-<span class="sourceLineNo">429</span> ex.initCause(e);<a name="line.429"></a>
-<span class="sourceLineNo">430</span> throw ex;<a name="line.430"></a>
-<span class="sourceLineNo">431</span> }<a name="line.431"></a>
-<span class="sourceLineNo">432</span> } else {<a name="line.432"></a>
-<span class="sourceLineNo">433</span> // If exception is any but the list below throw it back to the client; else setup<a name="line.433"></a>
-<span class="sourceLineNo">434</span> // the scanner and retry.<a name="line.434"></a>
-<span class="sourceLineNo">435</span> Throwable cause = e.getCause();<a name="line.435"></a>
-<span class="sourceLineNo">436</span> if ((cause != null && cause instanceof NotServingRegionException) ||<a name="line.436"></a>
-<span class="sourceLineNo">437</span> (cause != null && cause instanceof RegionServerStoppedException) ||<a name="line.437"></a>
-<span class="sourceLineNo">438</span> e instanceof OutOfOrderScannerNextException) {<a name="line.438"></a>
-<span class="sourceLineNo">439</span> // Pass. It is easier writing the if loop test as list of what is allowed rather than<a name="line.439"></a>
-<span class="sourceLineNo">440</span> // as a list of what is not allowed... so if in here, it means we do not throw.<a name="line.440"></a>
-<span class="sourceLineNo">441</span> } else {<a name="line.441"></a>
-<span class="sourceLineNo">442</span> throw e;<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> // Else, its signal from depths of ScannerCallable that we need to reset the scanner.<a name="line.445"></a>
-<span class="sourceLineNo">446</span> if (this.lastResult != null) {<a name="line.446"></a>
-<span class="sourceLineNo">447</span> // The region has moved. We need to open a brand new scanner at the new location.<a name="line.447"></a>
-<span class="sourceLineNo">448</span> // Reset the startRow to the row we've seen last so that the new scanner starts at<a name="line.448"></a>
-<span class="sourceLineNo">449</span> // the correct row. Otherwise we may see previously returned rows again.<a name="line.449"></a>
-<span class="sourceLineNo">450</span> // (ScannerCallable by now has "relocated" the correct region)<a name="line.450"></a>
-<span class="sourceLineNo">451</span> if (scan.isReversed()) {<a name="line.451"></a>
-<span class="sourceLineNo">452</span> scan.setStartRow(createClosestRowBefore(lastResult.getRow()));<a name="line.452"></a>
-<span class="sourceLineNo">453</span> } else {<a name="line.453"></a>
-<span class="sourceLineNo">454</span> scan.setStartRow(Bytes.add(lastResult.getRow(), new byte[1]));<a name="line.454"></a>
-<span class="sourceLineNo">455</span> }<a name="line.455"></a>
-<span class="sourceLineNo">456</span> }<a name="line.456"></a>
-<span class="sourceLineNo">457</span> if (e instanceof OutOfOrderScannerNextException) {<a name="line.457"></a>
-<span class="sourceLineNo">458</span> if (retryAfterOutOfOrderException) {<a name="line.458"></a>
-<span class="sourceLineNo">459</span> retryAfterOutOfOrderException = false;<a name="line.459"></a>
-<span class="sourceLineNo">460</span> } else {<a name="line.460"></a>
-<span class="sourceLineNo">461</span> // TODO: Why wrap this in a DNRIOE when it already is a DNRIOE?<a name="line.461"></a>
-<span class="sourceLineNo">462</span> throw new DoNotRetryIOException("Failed after retry of " +<a name="line.462"></a>
-<span class="sourceLineNo">463</span> "OutOfOrderScannerNextException: was there a rpc timeout?", e);<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> // Clear region.<a name="line.466"></a>
-<span class="sourceLineNo">467</span> this.currentRegion = null;<a name="line.467"></a>
-<span class="sourceLineNo">468</span> // Set this to zero so we don't try and do an rpc and close on remote server when<a name="line.468"></a>
-<span class="sourceLineNo">469</span> // the exception we got was UnknownScanner or the Server is going down.<a name="line.469"></a>
-<span class="sourceLineNo">470</span> callable = null;<a name="line.470"></a>
-<span class="sourceLineNo">471</span> // This continue will take us to while at end of loop where we will set up new scanner.<a name="line.471"></a>
-<span class="sourceLineNo">472</span> continue;<a name="line.472"></a>
-<span class="sourceLineNo">473</span> }<a name="line.473"></a>
-<span class="sourceLineNo">474</span> long currentTime = System.currentTimeMillis();<a name="line.474"></a>
-<span class="sourceLineNo">475</span> if (this.scanMetrics != null) {<a name="line.475"></a>
-<span class="sourceLineNo">476</span> this.scanMetrics.sumOfMillisSecBetweenNexts.addAndGet(currentTime - lastNext);<a name="line.476"></a>
-<span class="sourceLineNo">477</span> }<a name="line.477"></a>
-<span class="sourceLineNo">478</span> lastNext = currentTime;<a name="line.478"></a>
-<span class="sourceLineNo">479</span> // Groom the array of Results that we received back from the server before adding that<a name="line.479"></a>
-<span class="sourceLineNo">480</span> // Results to the scanner's cache. If partial results are not allowed to be seen by the<a name="line.480"></a>
-<span class="sourceLineNo">481</span> // caller, all book keeping will be performed within this method.<a name="line.481"></a>
-<span class="sourceLineNo">482</span> List<Result> resultsToAddToCache =<a name="line.482"></a>
-<span class="sourceLineNo">483</span> getResultsToAddToCache(values, callable.isHeartbeatMessage());<a name="line.483"></a>
-<span class="sourceLineNo">484</span> if (!resultsToAddToCache.isEmpty()) {<a name="line.484"></a>
-<span class="sourceLineNo">485</span> for (Result rs : resultsToAddToCache) {<a name="line.485"></a>
-<span class="sourceLineNo">486</span> cache.add(rs);<a name="line.486"></a>
-<span class="sourceLineNo">487</span> long estimatedHeapSizeOfResult = calcEstimatedSize(rs);<a name="line.487"></a>
-<span class="sourceLineNo">488</span> countdown--;<a name="line.488"></a>
-<span class="sourceLineNo">489</span> remainingResultSize -= estimatedHeapSizeOfResult;<a name="line.489"></a>
-<span class="sourceLineNo">490</span> addEstimatedSize(estimatedHeapSizeOfResult);<a name="line.490"></a>
-<span class="sourceLineNo">491</span> this.lastResult = rs;<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> if (callable.isHeartbeatMessage()) {<a name="line.494"></a>
-<span class="sourceLineNo">495</span> if (cache.size() > 0) {<a name="line.495"></a>
-<span class="sourceLineNo">496</span> // Caller of this method just wants a Result. If we see a heartbeat message, it means<a name="line.496"></a>
-<span class="sourceLineNo">497</span> // processing of the scan is taking a long time server side. Rather than continue to<a name="line.497"></a>
-<span class="sourceLineNo">498</span> // loop until a limit (e.g. size or caching) is reached, break out early to avoid causing<a name="line.498"></a>
-<span class="sourceLineNo">499</span> // unnecesary delays to the caller<a name="line.499"></a>
-<span class="sourceLineNo">500</span> if (LOG.isTraceEnabled()) {<a name="line.500"></a>
-<span class="sourceLineNo">501</span> LOG.trace("Heartbeat message received and cache contains Results."<a name="line.501"></a>
-<span class="sourceLineNo">502</span> + " Breaking out of scan loop");<a name="line.502"></a>
-<span class="sourceLineNo">503</span> }<a name="line.503"></a>
-<span class="sourceLineNo">504</span> break;<a name="line.504"></a>
-<span class="sourceLineNo">505</span> }<a name="line.505"></a>
-<span class="sourceLineNo">506</span> continue;<a name="line.506"></a>
-<span class="sourceLineNo">507</span> }<a name="line.507"></a>
-<span class="sourceLineNo">508</span><a name="line.508"></a>
-<span class="sourceLineNo">509</span> // We expect that the server won't have more results for us when we exhaust<a name="line.509"></a>
-<span class="sourceLineNo">510</span> // the size (bytes or count) of the results returned. If the server *does* inform us that<a name="line.510"></a>
-<span class="sourceLineNo">511</span> // there are more results, we want to avoid possiblyNextScanner(...). Only when we actually<a name="line.511"></a>
-<span class="sourceLineNo">512</span> // get results is the moreResults context valid.<a name="line.512"></a>
-<span class="sourceLineNo">513</span> if (null != values && values.length > 0 && callable.hasMoreResultsContext()) {<a name="line.513"></a>
-<span class="sourceLineNo">514</span> // Only adhere to more server results when we don't have any partialResults<a name="line.514"></a>
-<span class="sourceLineNo">515</span> // as it keeps the outer loop logic the same.<a name="line.515"></a>
-<span class="sourceLineNo">516</span> serverHasMoreResults = callable.getServerHasMoreResults() && partialResults.isEmpty();<a name="line.516"></a>
-<span class="sourceLineNo">517</span> }<a name="line.517"></a>
-<span class="sourceLineNo">518</span> // Values == null means server-side filter has determined we must STOP<a name="line.518"></a>
-<span class="sourceLineNo">519</span> // !partialResults.isEmpty() means that we are still accumulating partial Results for a<a name="line.519"></a>
-<span class="sourceLineNo">520</span> // row. We should not change scanners before we receive all the partial Results for that<a name="line.520"></a>
-<span class="sourceLineNo">521</span> // row.<a name="line.521"></a>
-<span class="sourceLineNo">522</span> } while ((callable != null && callable.isHeartbeatMessage())<a name="line.522"></a>
-<span class="sourceLineNo">523</span> || (doneWithRegion(remainingResultSize, countdown, serverHasMoreResults)<a name="line.523"></a>
-<span class="sourceLineNo">524</span> && (!partialResults.isEmpty() || possiblyNextScanner(countdown, values == null))));<a name="line.524"></a>
-<span class="sourceLineNo">525</span> }<a name="line.525"></a>
-<span class="sourceLineNo">526</span><a name="line.526"></a>
-<span class="sourceLineNo">527</span> /**<a name="line.527"></a>
-<span class="sourceLineNo">528</span> * @param remainingResultSize<a name="line.528"></a>
-<span class="sourceLineNo">529</span> * @param remainingRows<a name="line.529"></a>
-<span class="sourceLineNo">530</span> * @param regionHasMoreResults<a name="line.530"></a>
-<span class="sourceLineNo">531</span> * @return true when the current region has been exhausted. When the current region has been<a name="line.531"></a>
-<span class="sourceLineNo">532</span> * exhausted, the region must be changed before scanning can continue<a name="line.532"></a>
-<span class="sourceLineNo">533</span> */<a name="line.533"></a>
-<span class="sourceLineNo">534</span> private boolean doneWithRegion(long remainingResultSize, int remainingRows,<a name="line.534"></a>
-<span class="sourceLineNo">535</span> boolean regionHasMoreResults) {<a name="line.535"></a>
-<span class="sourceLineNo">536</span> return remainingResultSize > 0 && remainingRows > 0 && !regionHasMoreResults;<a name="line.536"></a>
-<span class="sourceLineNo">537</span> }<a name="line.537"></a>
-<span class="sourceLineNo">538</span><a name="line.538"></a>
-<span class="sourceLineNo">539</span> protected long calcEstimatedSize(Result rs) {<a name="line.539"></a>
-<span class="sourceLineNo">540</span> long estimatedHeapSizeOfResult = 0;<a name="line.540"></a>
-<span class="sourceLineNo">541</span> // We don't make Iterator here<a name="line.541"></a>
-<span class="sourceLineNo">542</span> for (Cell cell : rs.rawCells()) {<a name="line.542"></a>
-<span class="sourceLineNo">543</span> estimatedHeapSizeOfResult += CellUtil.estimatedHeapSizeOf(cell);<a name="line.543"></a>
-<span class="sourceLineNo">544</span> }<a name="line.544"></a>
-<span class="sourceLineNo">545</span> return estimatedHeapSizeOfResult;<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> protected void addEstimatedSize(long estimatedHeapSizeOfResult) {<a name="line.548"></a>
-<span class="sourceLineNo">549</span> return;<a name="line.54
<TRUNCATED>