http://git-wip-us.apache.org/repos/asf/hbase-site/blob/32d40534/devapidocs/src-html/org/apache/hadoop/hbase/client/ScannerCallable.html
----------------------------------------------------------------------
diff --git
a/devapidocs/src-html/org/apache/hadoop/hbase/client/ScannerCallable.html
b/devapidocs/src-html/org/apache/hadoop/hbase/client/ScannerCallable.html
index 29cd355..1a7a6d9 100644
--- a/devapidocs/src-html/org/apache/hadoop/hbase/client/ScannerCallable.html
+++ b/devapidocs/src-html/org/apache/hadoop/hbase/client/ScannerCallable.html
@@ -79,410 +79,420 @@
<span class="sourceLineNo">071</span> protected long scannerId = -1L;<a
name="line.71"></a>
<span class="sourceLineNo">072</span> protected boolean instantiated =
false;<a name="line.72"></a>
<span class="sourceLineNo">073</span> protected boolean closed = false;<a
name="line.73"></a>
-<span class="sourceLineNo">074</span> private Scan scan;<a name="line.74"></a>
-<span class="sourceLineNo">075</span> private int caching = 1;<a
name="line.75"></a>
-<span class="sourceLineNo">076</span> protected final ClusterConnection
cConnection;<a name="line.76"></a>
-<span class="sourceLineNo">077</span> protected ScanMetrics scanMetrics;<a
name="line.77"></a>
-<span class="sourceLineNo">078</span> private boolean logScannerActivity =
false;<a name="line.78"></a>
-<span class="sourceLineNo">079</span> private int logCutOffLatency = 1000;<a
name="line.79"></a>
-<span class="sourceLineNo">080</span> private static String myAddress;<a
name="line.80"></a>
-<span class="sourceLineNo">081</span> protected final int id;<a
name="line.81"></a>
-<span class="sourceLineNo">082</span> protected boolean
serverHasMoreResultsContext;<a name="line.82"></a>
-<span class="sourceLineNo">083</span> protected boolean
serverHasMoreResults;<a name="line.83"></a>
-<span class="sourceLineNo">084</span><a name="line.84"></a>
-<span class="sourceLineNo">085</span> /**<a name="line.85"></a>
-<span class="sourceLineNo">086</span> * Saves whether or not the most recent
response from the server was a heartbeat message.<a name="line.86"></a>
-<span class="sourceLineNo">087</span> * Heartbeat messages are identified by
the flag {@link ScanResponse#getHeartbeatMessage()}<a name="line.87"></a>
-<span class="sourceLineNo">088</span> */<a name="line.88"></a>
-<span class="sourceLineNo">089</span> protected boolean heartbeatMessage =
false;<a name="line.89"></a>
-<span class="sourceLineNo">090</span> static {<a name="line.90"></a>
-<span class="sourceLineNo">091</span> try {<a name="line.91"></a>
-<span class="sourceLineNo">092</span> myAddress =
DNS.getDefaultHost("default", "default");<a name="line.92"></a>
-<span class="sourceLineNo">093</span> } catch (UnknownHostException uhe)
{<a name="line.93"></a>
-<span class="sourceLineNo">094</span> LOG.error("cannot determine my
address", uhe);<a name="line.94"></a>
-<span class="sourceLineNo">095</span> }<a name="line.95"></a>
-<span class="sourceLineNo">096</span> }<a name="line.96"></a>
-<span class="sourceLineNo">097</span><a name="line.97"></a>
-<span class="sourceLineNo">098</span> // indicate if it is a remote server
call<a name="line.98"></a>
-<span class="sourceLineNo">099</span> protected boolean isRegionServerRemote
= true;<a name="line.99"></a>
-<span class="sourceLineNo">100</span> private long nextCallSeq = 0;<a
name="line.100"></a>
-<span class="sourceLineNo">101</span> protected RpcControllerFactory
controllerFactory;<a name="line.101"></a>
-<span class="sourceLineNo">102</span> protected PayloadCarryingRpcController
controller;<a name="line.102"></a>
-<span class="sourceLineNo">103</span><a name="line.103"></a>
-<span class="sourceLineNo">104</span> /**<a name="line.104"></a>
-<span class="sourceLineNo">105</span> * @param connection which connection<a
name="line.105"></a>
-<span class="sourceLineNo">106</span> * @param tableName table callable is
on<a name="line.106"></a>
-<span class="sourceLineNo">107</span> * @param scan the scan to execute<a
name="line.107"></a>
-<span class="sourceLineNo">108</span> * @param scanMetrics the ScanMetrics
to used, if it is null, ScannerCallable won't collect<a name="line.108"></a>
-<span class="sourceLineNo">109</span> * metrics<a
name="line.109"></a>
-<span class="sourceLineNo">110</span> * @param rpcControllerFactory factory
to use when creating <a name="line.110"></a>
-<span class="sourceLineNo">111</span> * {@link
com.google.protobuf.RpcController}<a name="line.111"></a>
-<span class="sourceLineNo">112</span> */<a name="line.112"></a>
-<span class="sourceLineNo">113</span> public
ScannerCallable(ClusterConnection connection, TableName tableName, Scan scan,<a
name="line.113"></a>
-<span class="sourceLineNo">114</span> ScanMetrics scanMetrics,
RpcControllerFactory rpcControllerFactory) {<a name="line.114"></a>
-<span class="sourceLineNo">115</span> this(connection, tableName, scan,
scanMetrics, rpcControllerFactory, 0);<a name="line.115"></a>
-<span class="sourceLineNo">116</span> }<a name="line.116"></a>
-<span class="sourceLineNo">117</span> /**<a name="line.117"></a>
-<span class="sourceLineNo">118</span> *<a name="line.118"></a>
-<span class="sourceLineNo">119</span> * @param connection<a
name="line.119"></a>
-<span class="sourceLineNo">120</span> * @param tableName<a
name="line.120"></a>
-<span class="sourceLineNo">121</span> * @param scan<a name="line.121"></a>
-<span class="sourceLineNo">122</span> * @param scanMetrics<a
name="line.122"></a>
-<span class="sourceLineNo">123</span> * @param id the replicaId<a
name="line.123"></a>
-<span class="sourceLineNo">124</span> */<a name="line.124"></a>
-<span class="sourceLineNo">125</span> public
ScannerCallable(ClusterConnection connection, TableName tableName, Scan scan,<a
name="line.125"></a>
-<span class="sourceLineNo">126</span> ScanMetrics scanMetrics,
RpcControllerFactory rpcControllerFactory, int id) {<a name="line.126"></a>
-<span class="sourceLineNo">127</span> super(connection, tableName,
scan.getStartRow());<a name="line.127"></a>
-<span class="sourceLineNo">128</span> this.id = id;<a name="line.128"></a>
-<span class="sourceLineNo">129</span> this.cConnection = connection;<a
name="line.129"></a>
-<span class="sourceLineNo">130</span> this.scan = scan;<a
name="line.130"></a>
-<span class="sourceLineNo">131</span> this.scanMetrics = scanMetrics;<a
name="line.131"></a>
-<span class="sourceLineNo">132</span> Configuration conf =
connection.getConfiguration();<a name="line.132"></a>
-<span class="sourceLineNo">133</span> logScannerActivity =
conf.getBoolean(LOG_SCANNER_ACTIVITY, false);<a name="line.133"></a>
-<span class="sourceLineNo">134</span> logCutOffLatency =
conf.getInt(LOG_SCANNER_LATENCY_CUTOFF, 1000);<a name="line.134"></a>
-<span class="sourceLineNo">135</span> this.controllerFactory =
rpcControllerFactory;<a name="line.135"></a>
-<span class="sourceLineNo">136</span> }<a name="line.136"></a>
-<span class="sourceLineNo">137</span><a name="line.137"></a>
-<span class="sourceLineNo">138</span> PayloadCarryingRpcController
getController() {<a name="line.138"></a>
-<span class="sourceLineNo">139</span> return controller;<a
name="line.139"></a>
-<span class="sourceLineNo">140</span> }<a name="line.140"></a>
-<span class="sourceLineNo">141</span><a name="line.141"></a>
-<span class="sourceLineNo">142</span> /**<a name="line.142"></a>
-<span class="sourceLineNo">143</span> * @param reload force reload of server
location<a name="line.143"></a>
-<span class="sourceLineNo">144</span> * @throws IOException<a
name="line.144"></a>
-<span class="sourceLineNo">145</span> */<a name="line.145"></a>
-<span class="sourceLineNo">146</span> @Override<a name="line.146"></a>
-<span class="sourceLineNo">147</span> public void prepare(boolean reload)
throws IOException {<a name="line.147"></a>
-<span class="sourceLineNo">148</span> if (Thread.interrupted()) {<a
name="line.148"></a>
-<span class="sourceLineNo">149</span> throw new
InterruptedIOException();<a name="line.149"></a>
-<span class="sourceLineNo">150</span> }<a name="line.150"></a>
-<span class="sourceLineNo">151</span> RegionLocations rl =
RpcRetryingCallerWithReadReplicas.getRegionLocations(!reload,<a
name="line.151"></a>
-<span class="sourceLineNo">152</span> id, getConnection(),
getTableName(), getRow());<a name="line.152"></a>
-<span class="sourceLineNo">153</span> location = id < rl.size() ?
rl.getRegionLocation(id) : null;<a name="line.153"></a>
-<span class="sourceLineNo">154</span> if (location == null ||
location.getServerName() == null) {<a name="line.154"></a>
-<span class="sourceLineNo">155</span> // With this exception, there will
be a retry. The location can be null for a replica<a name="line.155"></a>
-<span class="sourceLineNo">156</span> // when the table is created or
after a split.<a name="line.156"></a>
-<span class="sourceLineNo">157</span> throw new HBaseIOException("There
is no location for replica id #" + id);<a name="line.157"></a>
-<span class="sourceLineNo">158</span> }<a name="line.158"></a>
-<span class="sourceLineNo">159</span> ServerName dest =
location.getServerName();<a name="line.159"></a>
-<span class="sourceLineNo">160</span>
setStub(super.getConnection().getClient(dest));<a name="line.160"></a>
-<span class="sourceLineNo">161</span> if (!instantiated || reload) {<a
name="line.161"></a>
-<span class="sourceLineNo">162</span> checkIfRegionServerIsRemote();<a
name="line.162"></a>
-<span class="sourceLineNo">163</span> instantiated = true;<a
name="line.163"></a>
-<span class="sourceLineNo">164</span> }<a name="line.164"></a>
-<span class="sourceLineNo">165</span><a name="line.165"></a>
-<span class="sourceLineNo">166</span> // check how often we retry.<a
name="line.166"></a>
-<span class="sourceLineNo">167</span> if (reload &&
this.scanMetrics != null) {<a name="line.167"></a>
-<span class="sourceLineNo">168</span>
this.scanMetrics.countOfRPCRetries.incrementAndGet();<a name="line.168"></a>
-<span class="sourceLineNo">169</span> if (isRegionServerRemote) {<a
name="line.169"></a>
-<span class="sourceLineNo">170</span>
this.scanMetrics.countOfRemoteRPCRetries.incrementAndGet();<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> }<a name="line.173"></a>
-<span class="sourceLineNo">174</span><a name="line.174"></a>
-<span class="sourceLineNo">175</span> /**<a name="line.175"></a>
-<span class="sourceLineNo">176</span> * compare the local machine hostname
with region server's hostname<a name="line.176"></a>
-<span class="sourceLineNo">177</span> * to decide if hbase client connects
to a remote region server<a name="line.177"></a>
-<span class="sourceLineNo">178</span> */<a name="line.178"></a>
-<span class="sourceLineNo">179</span> protected void
checkIfRegionServerIsRemote() {<a name="line.179"></a>
-<span class="sourceLineNo">180</span> if
(getLocation().getHostname().equalsIgnoreCase(myAddress)) {<a
name="line.180"></a>
-<span class="sourceLineNo">181</span> isRegionServerRemote = false;<a
name="line.181"></a>
-<span class="sourceLineNo">182</span> } else {<a name="line.182"></a>
-<span class="sourceLineNo">183</span> isRegionServerRemote = true;<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><a name="line.186"></a>
+<span class="sourceLineNo">074</span> protected boolean renew = false;<a
name="line.74"></a>
+<span class="sourceLineNo">075</span> private Scan scan;<a name="line.75"></a>
+<span class="sourceLineNo">076</span> private int caching = 1;<a
name="line.76"></a>
+<span class="sourceLineNo">077</span> protected final ClusterConnection
cConnection;<a name="line.77"></a>
+<span class="sourceLineNo">078</span> protected ScanMetrics scanMetrics;<a
name="line.78"></a>
+<span class="sourceLineNo">079</span> private boolean logScannerActivity =
false;<a name="line.79"></a>
+<span class="sourceLineNo">080</span> private int logCutOffLatency = 1000;<a
name="line.80"></a>
+<span class="sourceLineNo">081</span> private static String myAddress;<a
name="line.81"></a>
+<span class="sourceLineNo">082</span> protected final int id;<a
name="line.82"></a>
+<span class="sourceLineNo">083</span> protected boolean
serverHasMoreResultsContext;<a name="line.83"></a>
+<span class="sourceLineNo">084</span> protected boolean
serverHasMoreResults;<a name="line.84"></a>
+<span class="sourceLineNo">085</span><a name="line.85"></a>
+<span class="sourceLineNo">086</span> /**<a name="line.86"></a>
+<span class="sourceLineNo">087</span> * Saves whether or not the most recent
response from the server was a heartbeat message.<a name="line.87"></a>
+<span class="sourceLineNo">088</span> * Heartbeat messages are identified by
the flag {@link ScanResponse#getHeartbeatMessage()}<a name="line.88"></a>
+<span class="sourceLineNo">089</span> */<a name="line.89"></a>
+<span class="sourceLineNo">090</span> protected boolean heartbeatMessage =
false;<a name="line.90"></a>
+<span class="sourceLineNo">091</span> static {<a name="line.91"></a>
+<span class="sourceLineNo">092</span> try {<a name="line.92"></a>
+<span class="sourceLineNo">093</span> myAddress =
DNS.getDefaultHost("default", "default");<a name="line.93"></a>
+<span class="sourceLineNo">094</span> } catch (UnknownHostException uhe)
{<a name="line.94"></a>
+<span class="sourceLineNo">095</span> LOG.error("cannot determine my
address", uhe);<a name="line.95"></a>
+<span class="sourceLineNo">096</span> }<a name="line.96"></a>
+<span class="sourceLineNo">097</span> }<a name="line.97"></a>
+<span class="sourceLineNo">098</span><a name="line.98"></a>
+<span class="sourceLineNo">099</span> // indicate if it is a remote server
call<a name="line.99"></a>
+<span class="sourceLineNo">100</span> protected boolean isRegionServerRemote
= true;<a name="line.100"></a>
+<span class="sourceLineNo">101</span> private long nextCallSeq = 0;<a
name="line.101"></a>
+<span class="sourceLineNo">102</span> protected RpcControllerFactory
controllerFactory;<a name="line.102"></a>
+<span class="sourceLineNo">103</span> protected PayloadCarryingRpcController
controller;<a name="line.103"></a>
+<span class="sourceLineNo">104</span><a name="line.104"></a>
+<span class="sourceLineNo">105</span> /**<a name="line.105"></a>
+<span class="sourceLineNo">106</span> * @param connection which connection<a
name="line.106"></a>
+<span class="sourceLineNo">107</span> * @param tableName table callable is
on<a name="line.107"></a>
+<span class="sourceLineNo">108</span> * @param scan the scan to execute<a
name="line.108"></a>
+<span class="sourceLineNo">109</span> * @param scanMetrics the ScanMetrics
to used, if it is null, ScannerCallable won't collect<a name="line.109"></a>
+<span class="sourceLineNo">110</span> * metrics<a
name="line.110"></a>
+<span class="sourceLineNo">111</span> * @param rpcControllerFactory factory
to use when creating <a name="line.111"></a>
+<span class="sourceLineNo">112</span> * {@link
com.google.protobuf.RpcController}<a name="line.112"></a>
+<span class="sourceLineNo">113</span> */<a name="line.113"></a>
+<span class="sourceLineNo">114</span> public
ScannerCallable(ClusterConnection connection, TableName tableName, Scan scan,<a
name="line.114"></a>
+<span class="sourceLineNo">115</span> ScanMetrics scanMetrics,
RpcControllerFactory rpcControllerFactory) {<a name="line.115"></a>
+<span class="sourceLineNo">116</span> this(connection, tableName, scan,
scanMetrics, rpcControllerFactory, 0);<a name="line.116"></a>
+<span class="sourceLineNo">117</span> }<a name="line.117"></a>
+<span class="sourceLineNo">118</span> /**<a name="line.118"></a>
+<span class="sourceLineNo">119</span> *<a name="line.119"></a>
+<span class="sourceLineNo">120</span> * @param connection<a
name="line.120"></a>
+<span class="sourceLineNo">121</span> * @param tableName<a
name="line.121"></a>
+<span class="sourceLineNo">122</span> * @param scan<a name="line.122"></a>
+<span class="sourceLineNo">123</span> * @param scanMetrics<a
name="line.123"></a>
+<span class="sourceLineNo">124</span> * @param id the replicaId<a
name="line.124"></a>
+<span class="sourceLineNo">125</span> */<a name="line.125"></a>
+<span class="sourceLineNo">126</span> public
ScannerCallable(ClusterConnection connection, TableName tableName, Scan scan,<a
name="line.126"></a>
+<span class="sourceLineNo">127</span> ScanMetrics scanMetrics,
RpcControllerFactory rpcControllerFactory, int id) {<a name="line.127"></a>
+<span class="sourceLineNo">128</span> super(connection, tableName,
scan.getStartRow());<a name="line.128"></a>
+<span class="sourceLineNo">129</span> this.id = id;<a name="line.129"></a>
+<span class="sourceLineNo">130</span> this.cConnection = connection;<a
name="line.130"></a>
+<span class="sourceLineNo">131</span> this.scan = scan;<a
name="line.131"></a>
+<span class="sourceLineNo">132</span> this.scanMetrics = scanMetrics;<a
name="line.132"></a>
+<span class="sourceLineNo">133</span> Configuration conf =
connection.getConfiguration();<a name="line.133"></a>
+<span class="sourceLineNo">134</span> logScannerActivity =
conf.getBoolean(LOG_SCANNER_ACTIVITY, false);<a name="line.134"></a>
+<span class="sourceLineNo">135</span> logCutOffLatency =
conf.getInt(LOG_SCANNER_LATENCY_CUTOFF, 1000);<a name="line.135"></a>
+<span class="sourceLineNo">136</span> this.controllerFactory =
rpcControllerFactory;<a name="line.136"></a>
+<span class="sourceLineNo">137</span> }<a name="line.137"></a>
+<span class="sourceLineNo">138</span><a name="line.138"></a>
+<span class="sourceLineNo">139</span> PayloadCarryingRpcController
getController() {<a name="line.139"></a>
+<span class="sourceLineNo">140</span> return controller;<a
name="line.140"></a>
+<span class="sourceLineNo">141</span> }<a name="line.141"></a>
+<span class="sourceLineNo">142</span><a name="line.142"></a>
+<span class="sourceLineNo">143</span> /**<a name="line.143"></a>
+<span class="sourceLineNo">144</span> * @param reload force reload of server
location<a name="line.144"></a>
+<span class="sourceLineNo">145</span> * @throws IOException<a
name="line.145"></a>
+<span class="sourceLineNo">146</span> */<a name="line.146"></a>
+<span class="sourceLineNo">147</span> @Override<a name="line.147"></a>
+<span class="sourceLineNo">148</span> public void prepare(boolean reload)
throws IOException {<a name="line.148"></a>
+<span class="sourceLineNo">149</span> if (Thread.interrupted()) {<a
name="line.149"></a>
+<span class="sourceLineNo">150</span> throw new
InterruptedIOException();<a name="line.150"></a>
+<span class="sourceLineNo">151</span> }<a name="line.151"></a>
+<span class="sourceLineNo">152</span> RegionLocations rl =
RpcRetryingCallerWithReadReplicas.getRegionLocations(!reload,<a
name="line.152"></a>
+<span class="sourceLineNo">153</span> id, getConnection(),
getTableName(), getRow());<a name="line.153"></a>
+<span class="sourceLineNo">154</span> location = id < rl.size() ?
rl.getRegionLocation(id) : null;<a name="line.154"></a>
+<span class="sourceLineNo">155</span> if (location == null ||
location.getServerName() == null) {<a name="line.155"></a>
+<span class="sourceLineNo">156</span> // With this exception, there will
be a retry. The location can be null for a replica<a name="line.156"></a>
+<span class="sourceLineNo">157</span> // when the table is created or
after a split.<a name="line.157"></a>
+<span class="sourceLineNo">158</span> throw new HBaseIOException("There
is no location for replica id #" + id);<a name="line.158"></a>
+<span class="sourceLineNo">159</span> }<a name="line.159"></a>
+<span class="sourceLineNo">160</span> ServerName dest =
location.getServerName();<a name="line.160"></a>
+<span class="sourceLineNo">161</span>
setStub(super.getConnection().getClient(dest));<a name="line.161"></a>
+<span class="sourceLineNo">162</span> if (!instantiated || reload) {<a
name="line.162"></a>
+<span class="sourceLineNo">163</span> checkIfRegionServerIsRemote();<a
name="line.163"></a>
+<span class="sourceLineNo">164</span> instantiated = true;<a
name="line.164"></a>
+<span class="sourceLineNo">165</span> }<a name="line.165"></a>
+<span class="sourceLineNo">166</span><a name="line.166"></a>
+<span class="sourceLineNo">167</span> // check how often we retry.<a
name="line.167"></a>
+<span class="sourceLineNo">168</span> if (reload &&
this.scanMetrics != null) {<a name="line.168"></a>
+<span class="sourceLineNo">169</span>
this.scanMetrics.countOfRPCRetries.incrementAndGet();<a name="line.169"></a>
+<span class="sourceLineNo">170</span> if (isRegionServerRemote) {<a
name="line.170"></a>
+<span class="sourceLineNo">171</span>
this.scanMetrics.countOfRemoteRPCRetries.incrementAndGet();<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> }<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> * compare the local machine hostname
with region server's hostname<a name="line.177"></a>
+<span class="sourceLineNo">178</span> * to decide if hbase client connects
to a remote region server<a name="line.178"></a>
+<span class="sourceLineNo">179</span> */<a name="line.179"></a>
+<span class="sourceLineNo">180</span> protected void
checkIfRegionServerIsRemote() {<a name="line.180"></a>
+<span class="sourceLineNo">181</span> if
(getLocation().getHostname().equalsIgnoreCase(myAddress)) {<a
name="line.181"></a>
+<span class="sourceLineNo">182</span> isRegionServerRemote = false;<a
name="line.182"></a>
+<span class="sourceLineNo">183</span> } else {<a name="line.183"></a>
+<span class="sourceLineNo">184</span> isRegionServerRemote = true;<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><a name="line.187"></a>
-<span class="sourceLineNo">188</span> @Override<a name="line.188"></a>
-<span class="sourceLineNo">189</span> public Result [] call(int callTimeout)
throws IOException {<a name="line.189"></a>
-<span class="sourceLineNo">190</span> if (Thread.interrupted()) {<a
name="line.190"></a>
-<span class="sourceLineNo">191</span> throw new
InterruptedIOException();<a name="line.191"></a>
-<span class="sourceLineNo">192</span> }<a name="line.192"></a>
-<span class="sourceLineNo">193</span> if (closed) {<a name="line.193"></a>
-<span class="sourceLineNo">194</span> if (scannerId != -1) {<a
name="line.194"></a>
-<span class="sourceLineNo">195</span> close();<a name="line.195"></a>
-<span class="sourceLineNo">196</span> }<a name="line.196"></a>
-<span class="sourceLineNo">197</span> } else {<a name="line.197"></a>
-<span class="sourceLineNo">198</span> if (scannerId == -1L) {<a
name="line.198"></a>
-<span class="sourceLineNo">199</span> this.scannerId = openScanner();<a
name="line.199"></a>
-<span class="sourceLineNo">200</span> } else {<a name="line.200"></a>
-<span class="sourceLineNo">201</span> Result [] rrs = null;<a
name="line.201"></a>
-<span class="sourceLineNo">202</span> ScanRequest request = null;<a
name="line.202"></a>
-<span class="sourceLineNo">203</span> // Reset the heartbeat flag prior
to each RPC in case an exception is thrown by the server<a name="line.203"></a>
-<span class="sourceLineNo">204</span> setHeartbeatMessage(false);<a
name="line.204"></a>
-<span class="sourceLineNo">205</span> try {<a name="line.205"></a>
-<span class="sourceLineNo">206</span> incRPCcallsMetrics();<a
name="line.206"></a>
-<span class="sourceLineNo">207</span> request =<a name="line.207"></a>
-<span class="sourceLineNo">208</span>
RequestConverter.buildScanRequest(scannerId, caching, false, nextCallSeq,<a
name="line.208"></a>
-<span class="sourceLineNo">209</span> this.scanMetrics !=
null);<a name="line.209"></a>
-<span class="sourceLineNo">210</span> ScanResponse response = null;<a
name="line.210"></a>
-<span class="sourceLineNo">211</span> controller =
controllerFactory.newController();<a name="line.211"></a>
-<span class="sourceLineNo">212</span>
controller.setPriority(getTableName());<a name="line.212"></a>
-<span class="sourceLineNo">213</span>
controller.setCallTimeout(callTimeout);<a name="line.213"></a>
-<span class="sourceLineNo">214</span> try {<a name="line.214"></a>
-<span class="sourceLineNo">215</span> response =
getStub().scan(controller, request);<a name="line.215"></a>
-<span class="sourceLineNo">216</span> // Client and RS maintain a
nextCallSeq number during the scan. Every next() call<a name="line.216"></a>
-<span class="sourceLineNo">217</span> // from client to server will
increment this number in both sides. Client passes this<a name="line.217"></a>
-<span class="sourceLineNo">218</span> // number along with the
request and at RS side both the incoming nextCallSeq and its<a
name="line.218"></a>
-<span class="sourceLineNo">219</span> // nextCallSeq will be
matched. In case of a timeout this increment at the client side<a
name="line.219"></a>
-<span class="sourceLineNo">220</span> // should not happen. If at
the server side fetching of next batch of data was over,<a name="line.220"></a>
-<span class="sourceLineNo">221</span> // there will be mismatch in
the nextCallSeq number. Server will throw<a name="line.221"></a>
-<span class="sourceLineNo">222</span> //
OutOfOrderScannerNextException and then client will reopen the scanner with
startrow<a name="line.222"></a>
-<span class="sourceLineNo">223</span> // as the last successfully
retrieved row.<a name="line.223"></a>
-<span class="sourceLineNo">224</span> // See HBASE-5974<a
name="line.224"></a>
-<span class="sourceLineNo">225</span> nextCallSeq++;<a
name="line.225"></a>
-<span class="sourceLineNo">226</span> long timestamp =
System.currentTimeMillis();<a name="line.226"></a>
-<span class="sourceLineNo">227</span>
setHeartbeatMessage(response.hasHeartbeatMessage() &&
response.getHeartbeatMessage());<a name="line.227"></a>
-<span class="sourceLineNo">228</span> // Results are returned via
controller<a name="line.228"></a>
-<span class="sourceLineNo">229</span> CellScanner cellScanner =
controller.cellScanner();<a name="line.229"></a>
-<span class="sourceLineNo">230</span> rrs =
ResponseConverter.getResults(cellScanner, response);<a name="line.230"></a>
-<span class="sourceLineNo">231</span> if (logScannerActivity) {<a
name="line.231"></a>
-<span class="sourceLineNo">232</span> long now =
System.currentTimeMillis();<a name="line.232"></a>
-<span class="sourceLineNo">233</span> if (now - timestamp >
logCutOffLatency) {<a name="line.233"></a>
-<span class="sourceLineNo">234</span> int rows = rrs == null ?
0 : rrs.length;<a name="line.234"></a>
-<span class="sourceLineNo">235</span> LOG.info("Took " +
(now-timestamp) + "ms to fetch "<a name="line.235"></a>
-<span class="sourceLineNo">236</span> + rows + " rows from
scanner=" + scannerId);<a name="line.236"></a>
-<span class="sourceLineNo">237</span> }<a name="line.237"></a>
-<span class="sourceLineNo">238</span> }<a name="line.238"></a>
-<span class="sourceLineNo">239</span>
updateServerSideMetrics(response);<a name="line.239"></a>
-<span class="sourceLineNo">240</span> // moreResults is only used
for the case where a filter exhausts all elements<a name="line.240"></a>
-<span class="sourceLineNo">241</span> if (response.hasMoreResults()
&& !response.getMoreResults()) {<a name="line.241"></a>
-<span class="sourceLineNo">242</span> scannerId = -1L;<a
name="line.242"></a>
-<span class="sourceLineNo">243</span> closed = true;<a
name="line.243"></a>
-<span class="sourceLineNo">244</span> // Implied that no results
were returned back, either.<a name="line.244"></a>
-<span class="sourceLineNo">245</span> return null;<a
name="line.245"></a>
-<span class="sourceLineNo">246</span> }<a name="line.246"></a>
-<span class="sourceLineNo">247</span> // moreResultsInRegion
explicitly defines when a RS may choose to terminate a batch due<a
name="line.247"></a>
-<span class="sourceLineNo">248</span> // to size or quantity of
results in the response.<a name="line.248"></a>
-<span class="sourceLineNo">249</span> if
(response.hasMoreResultsInRegion()) {<a name="line.249"></a>
-<span class="sourceLineNo">250</span> // Set what the RS said<a
name="line.250"></a>
-<span class="sourceLineNo">251</span>
setHasMoreResultsContext(true);<a name="line.251"></a>
-<span class="sourceLineNo">252</span>
setServerHasMoreResults(response.getMoreResultsInRegion());<a
name="line.252"></a>
-<span class="sourceLineNo">253</span> } else {<a
name="line.253"></a>
-<span class="sourceLineNo">254</span> // Server didn't respond
whether it has more results or not.<a name="line.254"></a>
-<span class="sourceLineNo">255</span>
setHasMoreResultsContext(false);<a name="line.255"></a>
-<span class="sourceLineNo">256</span> }<a name="line.256"></a>
-<span class="sourceLineNo">257</span> } catch (ServiceException se)
{<a name="line.257"></a>
-<span class="sourceLineNo">258</span> throw
ProtobufUtil.getRemoteException(se);<a name="line.258"></a>
-<span class="sourceLineNo">259</span> }<a name="line.259"></a>
-<span class="sourceLineNo">260</span> updateResultsMetrics(rrs);<a
name="line.260"></a>
-<span class="sourceLineNo">261</span> } catch (IOException e) {<a
name="line.261"></a>
-<span class="sourceLineNo">262</span> if (logScannerActivity) {<a
name="line.262"></a>
-<span class="sourceLineNo">263</span> LOG.info("Got exception
making request " + TextFormat.shortDebugString(request)<a name="line.263"></a>
-<span class="sourceLineNo">264</span> + " to " + getLocation(),
e);<a name="line.264"></a>
-<span class="sourceLineNo">265</span> }<a name="line.265"></a>
-<span class="sourceLineNo">266</span> IOException ioe = e;<a
name="line.266"></a>
-<span class="sourceLineNo">267</span> if (e instanceof
RemoteException) {<a name="line.267"></a>
-<span class="sourceLineNo">268</span> ioe = ((RemoteException)
e).unwrapRemoteException();<a name="line.268"></a>
-<span class="sourceLineNo">269</span> }<a name="line.269"></a>
-<span class="sourceLineNo">270</span> if (logScannerActivity
&& (ioe instanceof UnknownScannerException)) {<a name="line.270"></a>
-<span class="sourceLineNo">271</span> try {<a name="line.271"></a>
-<span class="sourceLineNo">272</span> HRegionLocation location
=<a name="line.272"></a>
-<span class="sourceLineNo">273</span>
getConnection().relocateRegion(getTableName(), scan.getStartRow());<a
name="line.273"></a>
-<span class="sourceLineNo">274</span> LOG.info("Scanner=" +
scannerId<a name="line.274"></a>
-<span class="sourceLineNo">275</span> + " expired, current
region location is " + location.toString());<a name="line.275"></a>
-<span class="sourceLineNo">276</span> } catch (Throwable t) {<a
name="line.276"></a>
-<span class="sourceLineNo">277</span> LOG.info("Failed to
relocate region", t);<a name="line.277"></a>
-<span class="sourceLineNo">278</span> }<a name="line.278"></a>
-<span class="sourceLineNo">279</span> }<a name="line.279"></a>
-<span class="sourceLineNo">280</span> // The below convertion of
exceptions into DoNotRetryExceptions is a little strange.<a name="line.280"></a>
-<span class="sourceLineNo">281</span> // Why not just have these
exceptions implment DNRIOE you ask? Well, usually we want<a
name="line.281"></a>
-<span class="sourceLineNo">282</span> // ServerCallable#withRetries
to just retry when it gets these exceptions. In here in<a name="line.282"></a>
-<span class="sourceLineNo">283</span> // a scan when doing a next in
particular, we want to break out and get the scanner to<a name="line.283"></a>
-<span class="sourceLineNo">284</span> // reset itself up again.
Throwing a DNRIOE is how we signal this to happen (its ugly,<a
name="line.284"></a>
-<span class="sourceLineNo">285</span> // yeah and hard to follow and
in need of a refactor).<a name="line.285"></a>
-<span class="sourceLineNo">286</span> if (ioe instanceof
NotServingRegionException) {<a name="line.286"></a>
-<span class="sourceLineNo">287</span> // Throw a DNRE so that we
break out of cycle of calling NSRE<a name="line.287"></a>
-<span class="sourceLineNo">288</span> // when what we need is to
open scanner against new location.<a name="line.288"></a>
-<span class="sourceLineNo">289</span> // Attach NSRE to signal
client that it needs to re-setup scanner.<a name="line.289"></a>
-<span class="sourceLineNo">290</span> if (this.scanMetrics != null)
{<a name="line.290"></a>
-<span class="sourceLineNo">291</span>
this.scanMetrics.countOfNSRE.incrementAndGet();<a name="line.291"></a>
-<span class="sourceLineNo">292</span> }<a name="line.292"></a>
-<span class="sourceLineNo">293</span> throw new
DoNotRetryIOException("Resetting the scanner -- see exception cause", ioe);<a
name="line.293"></a>
-<span class="sourceLineNo">294</span> } else if (ioe instanceof
RegionServerStoppedException) {<a name="line.294"></a>
-<span class="sourceLineNo">295</span> // Throw a DNRE so that we
break out of cycle of the retries and instead go and<a name="line.295"></a>
-<span class="sourceLineNo">296</span> // open scanner against new
location.<a name="line.296"></a>
-<span class="sourceLineNo">297</span> throw new
DoNotRetryIOException("Resetting the scanner -- see exception cause", ioe);<a
name="line.297"></a>
-<span class="sourceLineNo">298</span> } else {<a name="line.298"></a>
-<span class="sourceLineNo">299</span> // The outer layers will
retry<a name="line.299"></a>
-<span class="sourceLineNo">300</span> throw ioe;<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> return rrs;<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> return null;<a name="line.306"></a>
-<span class="sourceLineNo">307</span> }<a name="line.307"></a>
-<span class="sourceLineNo">308</span><a name="line.308"></a>
-<span class="sourceLineNo">309</span> /**<a name="line.309"></a>
-<span class="sourceLineNo">310</span> * @return true when the most recent
RPC response indicated that the response was a heartbeat<a name="line.310"></a>
-<span class="sourceLineNo">311</span> * message. Heartbeat messages
are sent back from the server when the processing of the<a name="line.311"></a>
-<span class="sourceLineNo">312</span> * scan request exceeds a
certain time threshold. Heartbeats allow the server to avoid<a
name="line.312"></a>
-<span class="sourceLineNo">313</span> * timeouts during long running
scan operations.<a name="line.313"></a>
-<span class="sourceLineNo">314</span> */<a name="line.314"></a>
-<span class="sourceLineNo">315</span> protected boolean isHeartbeatMessage()
{<a name="line.315"></a>
-<span class="sourceLineNo">316</span> return heartbeatMessage;<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> protected void
setHeartbeatMessage(boolean heartbeatMessage) {<a name="line.319"></a>
-<span class="sourceLineNo">320</span> this.heartbeatMessage =
heartbeatMessage;<a name="line.320"></a>
-<span class="sourceLineNo">321</span> }<a name="line.321"></a>
-<span class="sourceLineNo">322</span><a name="line.322"></a>
-<span class="sourceLineNo">323</span> private void incRPCcallsMetrics() {<a
name="line.323"></a>
-<span class="sourceLineNo">324</span> if (this.scanMetrics == null) {<a
name="line.324"></a>
-<span class="sourceLineNo">325</span> return;<a name="line.325"></a>
-<span class="sourceLineNo">326</span> }<a name="line.326"></a>
-<span class="sourceLineNo">327</span>
this.scanMetrics.countOfRPCcalls.incrementAndGet();<a name="line.327"></a>
-<span class="sourceLineNo">328</span> if (isRegionServerRemote) {<a
name="line.328"></a>
-<span class="sourceLineNo">329</span>
this.scanMetrics.countOfRemoteRPCcalls.incrementAndGet();<a name="line.329"></a>
-<span class="sourceLineNo">330</span> }<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> protected void
updateResultsMetrics(Result[] rrs) {<a name="line.333"></a>
-<span class="sourceLineNo">334</span> if (this.scanMetrics == null || rrs
== null || rrs.length == 0) {<a name="line.334"></a>
-<span class="sourceLineNo">335</span> return;<a name="line.335"></a>
-<span class="sourceLineNo">336</span> }<a name="line.336"></a>
-<span class="sourceLineNo">337</span> long resultSize = 0;<a
name="line.337"></a>
-<span class="sourceLineNo">338</span> for (Result rr : rrs) {<a
name="line.338"></a>
-<span class="sourceLineNo">339</span> for (Cell cell : rr.rawCells()) {<a
name="line.339"></a>
-<span class="sourceLineNo">340</span> resultSize +=
CellUtil.estimatedSerializedSizeOf(cell);<a name="line.340"></a>
-<span class="sourceLineNo">341</span> }<a name="line.341"></a>
-<span class="sourceLineNo">342</span> }<a name="line.342"></a>
-<span class="sourceLineNo">343</span>
this.scanMetrics.countOfBytesInResults.addAndGet(resultSize);<a
name="line.343"></a>
-<span class="sourceLineNo">344</span> if (isRegionServerRemote) {<a
name="line.344"></a>
-<span class="sourceLineNo">345</span>
this.scanMetrics.countOfBytesInRemoteResults.addAndGet(resultSize);<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><a name="line.348"></a>
-<span class="sourceLineNo">349</span> /**<a name="line.349"></a>
-<span class="sourceLineNo">350</span> * Use the scan metrics returned by the
server to add to the identically named counters in the<a name="line.350"></a>
-<span class="sourceLineNo">351</span> * client side metrics. If a counter
does not exist with the same name as the server side metric,<a
name="line.351"></a>
-<span class="sourceLineNo">352</span> * the attempt to increase the counter
will fail.<a name="line.352"></a>
-<span class="sourceLineNo">353</span> * @param response<a
name="line.353"></a>
-<span class="sourceLineNo">354</span> */<a name="line.354"></a>
-<span class="sourceLineNo">355</span> private void
updateServerSideMetrics(ScanResponse response) {<a name="line.355"></a>
-<span class="sourceLineNo">356</span> if (this.scanMetrics == null ||
response == null || !response.hasScanMetrics()) return;<a name="line.356"></a>
-<span class="sourceLineNo">357</span><a name="line.357"></a>
-<span class="sourceLineNo">358</span> Map<String, Long> serverMetrics
= ResponseConverter.getScanMetrics(response);<a name="line.358"></a>
-<span class="sourceLineNo">359</span> for (Entry<String, Long> entry
: serverMetrics.entrySet()) {<a name="line.359"></a>
-<span class="sourceLineNo">360</span>
this.scanMetrics.addToCounter(entry.getKey(), entry.getValue());<a
name="line.360"></a>
-<span class="sourceLineNo">361</span> }<a name="line.361"></a>
-<span class="sourceLineNo">362</span> }<a name="line.362"></a>
-<span class="sourceLineNo">363</span><a name="line.363"></a>
-<span class="sourceLineNo">364</span> private void close() {<a
name="line.364"></a>
-<span class="sourceLineNo">365</span> if (this.scannerId == -1L) {<a
name="line.365"></a>
-<span class="sourceLineNo">366</span> return;<a name="line.366"></a>
-<span class="sourceLineNo">367</span> }<a name="line.367"></a>
-<span class="sourceLineNo">368</span> try {<a name="line.368"></a>
-<span class="sourceLineNo">369</span> incRPCcallsMetrics();<a
name="line.369"></a>
-<span class="sourceLineNo">370</span> ScanRequest request =<a
name="line.370"></a>
-<span class="sourceLineNo">371</span>
RequestConverter.buildScanRequest(this.scannerId, 0, true, this.scanMetrics !=
null);<a name="line.371"></a>
-<span class="sourceLineNo">372</span> try {<a name="line.372"></a>
-<span class="sourceLineNo">373</span> getStub().scan(null, request);<a
name="line.373"></a>
-<span class="sourceLineNo">374</span> } catch (ServiceException se) {<a
name="line.374"></a>
-<span class="sourceLineNo">375</span> throw
ProtobufUtil.getRemoteException(se);<a name="line.375"></a>
-<span class="sourceLineNo">376</span> }<a name="line.376"></a>
-<span class="sourceLineNo">377</span> } catch (IOException e) {<a
name="line.377"></a>
-<span class="sourceLineNo">378</span> LOG.warn("Ignore, probably already
closed", e);<a name="line.378"></a>
-<span class="sourceLineNo">379</span> }<a name="line.379"></a>
-<span class="sourceLineNo">380</span> this.scannerId = -1L;<a
name="line.380"></a>
-<span class="sourceLineNo">381</span> }<a name="line.381"></a>
-<span class="sourceLineNo">382</span><a name="line.382"></a>
-<span class="sourceLineNo">383</span> protected long openScanner() throws
IOException {<a name="line.383"></a>
-<span class="sourceLineNo">384</span> incRPCcallsMetrics();<a
name="line.384"></a>
-<span class="sourceLineNo">385</span> ScanRequest request =<a
name="line.385"></a>
-<span class="sourceLineNo">386</span>
RequestConverter.buildScanRequest(<a name="line.386"></a>
-<span class="sourceLineNo">387</span>
getLocation().getRegionInfo().getRegionName(),<a name="line.387"></a>
-<span class="sourceLineNo">388</span> this.scan, 0, false);<a
name="line.388"></a>
-<span class="sourceLineNo">389</span> try {<a name="line.389"></a>
-<span class="sourceLineNo">390</span> ScanResponse response =
getStub().scan(null, request);<a name="line.390"></a>
-<span class="sourceLineNo">391</span> long id =
response.getScannerId();<a name="line.391"></a>
-<span class="sourceLineNo">392</span> if (logScannerActivity) {<a
name="line.392"></a>
-<span class="sourceLineNo">393</span> LOG.info("Open scanner=" + id + "
for scan=" + scan.toString()<a name="line.393"></a>
-<span class="sourceLineNo">394</span> + " on region " +
getLocation().toString());<a name="line.394"></a>
-<span class="sourceLineNo">395</span> }<a name="line.395"></a>
-<span class="sourceLineNo">396</span> return id;<a name="line.396"></a>
-<span class="sourceLineNo">397</span> } catch (ServiceException se) {<a
name="line.397"></a>
-<span class="sourceLineNo">398</span> throw
ProtobufUtil.getRemoteException(se);<a name="line.398"></a>
-<span class="sourceLineNo">399</span> }<a name="line.399"></a>
-<span class="sourceLineNo">400</span> }<a name="line.400"></a>
-<span class="sourceLineNo">401</span><a name="line.401"></a>
-<span class="sourceLineNo">402</span> protected Scan getScan() {<a
name="line.402"></a>
-<span class="sourceLineNo">403</span> return scan;<a name="line.403"></a>
-<span class="sourceLineNo">404</span> }<a name="line.404"></a>
-<span class="sourceLineNo">405</span><a name="line.405"></a>
-<span class="sourceLineNo">406</span> /**<a name="line.406"></a>
-<span class="sourceLineNo">407</span> * Call this when the next invocation
of call should close the scanner<a name="line.407"></a>
-<span class="sourceLineNo">408</span> */<a name="line.408"></a>
-<span class="sourceLineNo">409</span> public void setClose() {<a
name="line.409"></a>
-<span class="sourceLineNo">410</span> this.closed = true;<a
name="line.410"></a>
-<span class="sourceLineNo">411</span> }<a name="line.411"></a>
-<span class="sourceLineNo">412</span><a name="line.412"></a>
-<span class="sourceLineNo">413</span> /**<a name="line.413"></a>
-<span class="sourceLineNo">414</span> * @return the HRegionInfo for the
current region<a name="line.414"></a>
-<span class="sourceLineNo">415</span> */<a name="line.415"></a>
-<span class="sourceLineNo">416</span> @Override<a name="line.416"></a>
-<span class="sourceLineNo">417</span> public HRegionInfo getHRegionInfo() {<a
name="line.417"></a>
-<span class="sourceLineNo">418</span> if (!instantiated) {<a
name="line.418"></a>
-<span class="sourceLineNo">419</span> return null;<a name="line.419"></a>
-<span class="sourceLineNo">420</span> }<a name="line.420"></a>
-<span class="sourceLineNo">421</span> return
getLocation().getRegionInfo();<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> /**<a name="line.424"></a>
-<span class="sourceLineNo">425</span> * Get the number of rows that will be
fetched on next<a name="line.425"></a>
-<span class="sourceLineNo">426</span> * @return the number of rows for
caching<a name="line.426"></a>
-<span class="sourceLineNo">427</span> */<a name="line.427"></a>
-<span class="sourceLineNo">428</span> public int getCaching() {<a
name="line.428"></a>
-<span class="sourceLineNo">429</span> return caching;<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> @Override<a name="line.432"></a>
-<span class="sourceLineNo">433</span> public ClusterConnection
getConnection() {<a name="line.433"></a>
-<span class="sourceLineNo">434</span> return cConnection;<a
name="line.434"></a>
-<span class="sourceLineNo">435</span> }<a name="line.435"></a>
-<span class="sourceLineNo">436</span><a name="line.436"></a>
-<span class="sourceLineNo">437</span> /**<a name="line.437"></a>
-<span class="sourceLineNo">438</span> * Set the number of rows that will be
fetched on next<a name="line.438"></a>
-<span class="sourceLineNo">439</span> * @param caching the number of rows
for caching<a name="line.439"></a>
-<span class="sourceLineNo">440</span> */<a name="line.440"></a>
-<span class="sourceLineNo">441</span> public void setCaching(int caching) {<a
name="line.441"></a>
-<span class="sourceLineNo">442</span> this.caching = caching;<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> public ScannerCallable
getScannerCallableForReplica(int id) {<a name="line.445"></a>
-<span class="sourceLineNo">446</span> ScannerCallable s = new
ScannerCallable(this.getConnection(), this.tableName,<a name="line.446"></a>
-<span class="sourceLineNo">447</span> this.getScan(), this.scanMetrics,
controllerFactory, id);<a name="line.447"></a>
-<span class="sourceLineNo">448</span> s.setCaching(this.caching);<a
name="line.448"></a>
-<span class="sourceLineNo">449</span> return s;<a name="line.449"></a>
-<span class="sourceLineNo">450</span> }<a name="line.450"></a>
-<span class="sourceLineNo">451</span><a name="line.451"></a>
-<span class="sourceLineNo">452</span> /**<a name="line.452"></a>
-<span class="sourceLineNo">453</span> * Should the client attempt to fetch
more results from this region<a name="line.453"></a>
-<span class="sourceLineNo">454</span> * @return True if the client should
attempt to fetch more results, false otherwise.<a name="line.454"></a>
-<span class="sourceLineNo">455</span> */<a name="line.455"></a>
-<span class="sourceLineNo">456</span> protected boolean
getServerHasMoreResults() {<a name="line.456"></a>
-<span class="sourceLineNo">457</span> assert serverHasMoreResultsContext;<a
name="line.457"></a>
-<span class="sourceLineNo">458</span> return this.serverHasMoreResults;<a
name="line.458"></a>
-<span class="sourceLineNo">459</span> }<a name="line.459"></a>
-<span class="sourceLineNo">460</span><a name="line.460"></a>
-<span class="sourceLineNo">461</span> protected void
setServerHasMoreResults(boolean serverHasMoreResults) {<a name="line.461"></a>
-<span class="sourceLineNo">462</span> this.serverHasMoreResults =
serverHasMoreResults;<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> * Did the server respond with
information about whether more results might exist.<a name="line.466"></a>
-<span class="sourceLineNo">467</span> * Not guaranteed to respond with older
server versions<a name="line.467"></a>
-<span class="sourceLineNo">468</span> * @return True if the server responded
with information about more results.<a name="line.468"></a>
-<span class="sourceLineNo">469</span> */<a name="line.469"></a>
-<span class="sourceLineNo">470</span> protected boolean
hasMoreResultsContext() {<a name="line.470"></a>
-<span class="sourceLineNo">471</span> return serverHasMoreResultsContext;<a
name="line.471"></a>
-<span class="sourceLineNo">472</span> }<a name="line.472"></a>
-<span class="sourceLineNo">473</span><a name="line.473"></a>
-<span class="sourceLineNo">474</span> protected void
setHasMoreResultsContext(boolean serverHasMoreResultsContext) {<a
name="line.474"></a>
-<span class="sourceLineNo">475</span> this.serverHasMoreResultsContext =
serverHasMoreResultsContext;<a name="line.475"></a>
-<span class="sourceLineNo">476</span> }<a name="line.476"></a>
-<span class="sourceLineNo">477</span>}<a name="line.477"></a>
+<span class="sourceLineNo">188</span><a name="line.188"></a>
+<span class="sourceLineNo">189</span> @Override<a name="line.189"></a>
+<span class="sourceLineNo">190</span> public Result [] call(int callTimeout)
throws IOException {<a name="line.190"></a>
+<span class="sourceLineNo">191</span> if (Thread.interrupted()) {<a
name="line.191"></a>
+<span class="sourceLineNo">192</span> throw new
InterruptedIOException();<a name="line.192"></a>
+<span class="sourceLineNo">193</span> }<a name="line.193"></a>
+<span class="sourceLineNo">194</span> if (closed) {<a name="line.194"></a>
+<span class="sourceLineNo">195</span> if (scannerId != -1) {<a
name="line.195"></a>
+<span class="sourceLineNo">196</span> close();<a name="line.196"></a>
+<span class="sourceLineNo">197</span> }<a name="line.197"></a>
+<span class="sourceLineNo">198</span> } else {<a name="line.198"></a>
+<span class="sourceLineNo">199</span> if (scannerId == -1L) {<a
name="line.199"></a>
+<span class="sourceLineNo">200</span> this.scannerId = openScanner();<a
name="line.200"></a>
+<span class="sourceLineNo">201</span> } else {<a name="line.201"></a>
+<span class="sourceLineNo">202</span> Result [] rrs = null;<a
name="line.202"></a>
+<span class="sourceLineNo">203</span> ScanRequest request = null;<a
name="line.203"></a>
+<span class="sourceLineNo">204</span> // Reset the heartbeat flag prior
to each RPC in case an exception is thrown by the server<a name="line.204"></a>
+<span class="sourceLineNo">205</span> setHeartbeatMessage(false);<a
name="line.205"></a>
+<span class="sourceLineNo">206</span> try {<a name="line.206"></a>
+<span class="sourceLineNo">207</span> incRPCcallsMetrics();<a
name="line.207"></a>
+<span class="sourceLineNo">208</span> request =<a name="line.208"></a>
+<span class="sourceLineNo">209</span>
RequestConverter.buildScanRequest(scannerId, caching, false, nextCallSeq,<a
name="line.209"></a>
+<span class="sourceLineNo">210</span> this.scanMetrics != null,
renew);<a name="line.210"></a>
+<span class="sourceLineNo">211</span> ScanResponse response = null;<a
name="line.211"></a>
+<span class="sourceLineNo">212</span> controller =
controllerFactory.newController();<a name="line.212"></a>
+<span class="sourceLineNo">213</span>
controller.setPriority(getTableName());<a name="line.213"></a>
+<span class="sourceLineNo">214</span>
controller.setCallTimeout(callTimeout);<a name="line.214"></a>
+<span class="sourceLineNo">215</span> try {<a name="line.215"></a>
+<span class="sourceLineNo">216</span> response =
getStub().scan(controller, request);<a name="line.216"></a>
+<span class="sourceLineNo">217</span> // Client and RS maintain a
nextCallSeq number during the scan. Every next() call<a name="line.217"></a>
+<span class="sourceLineNo">218</span> // from client to server will
increment this number in both sides. Client passes this<a name="line.218"></a>
+<span class="sourceLineNo">219</span> // number along with the
request and at RS side both the incoming nextCallSeq and its<a
name="line.219"></a>
+<span class="sourceLineNo">220</span> // nextCallSeq will be
matched. In case of a timeout this increment at the client side<a
name="line.220"></a>
+<span class="sourceLineNo">221</span> // should not happen. If at
the server side fetching of next batch of data was over,<a name="line.221"></a>
+<span class="sourceLineNo">222</span> // there will be mismatch in
the nextCallSeq number. Server will throw<a name="line.222"></a>
+<span class="sourceLineNo">223</span> //
OutOfOrderScannerNextException and then client will reopen the scanner with
startrow<a name="line.223"></a>
+<span class="sourceLineNo">224</span> // as the last successfully
retrieved row.<a name="line.224"></a>
+<span class="sourceLineNo">225</span> // See HBASE-5974<a
name="line.225"></a>
+<span class="sourceLineNo">226</span> nextCallSeq++;<a
name="line.226"></a>
+<span class="sourceLineNo">227</span> long timestamp =
System.currentTimeMillis();<a name="line.227"></a>
+<span class="sourceLineNo">228</span>
setHeartbeatMessage(response.hasHeartbeatMessage() &&
response.getHeartbeatMessage());<a name="line.228"></a>
+<span class="sourceLineNo">229</span> // Results are returned via
controller<a name="line.229"></a>
+<span class="sourceLineNo">230</span> CellScanner cellScanner =
controller.cellScanner();<a name="line.230"></a>
+<span class="sourceLineNo">231</span> rrs =
ResponseConverter.getResults(cellScanner, response);<a name="line.231"></a>
+<span class="sourceLineNo">232</span> if (logScannerActivity) {<a
name="line.232"></a>
+<span class="sourceLineNo">233</span> long now =
System.currentTimeMillis();<a name="line.233"></a>
+<span class="sourceLineNo">234</span> if (now - timestamp >
logCutOffLatency) {<a name="line.234"></a>
+<span class="sourceLineNo">235</span> int rows = rrs == null ?
0 : rrs.length;<a name="line.235"></a>
+<span class="sourceLineNo">236</span> LOG.info("Took " +
(now-timestamp) + "ms to fetch "<a name="line.236"></a>
+<span class="sourceLineNo">237</span> + rows + " rows from
scanner=" + scannerId);<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>
updateServerSideMetrics(response);<a name="line.240"></a>
+<span class="sourceLineNo">241</span> // moreResults is only used
for the case where a filter exhausts all elements<a name="line.241"></a>
+<span class="sourceLineNo">242</span> if (response.hasMoreResults()
&& !response.getMoreResults()) {<a name="line.242"></a>
+<span class="sourceLineNo">243</span> scannerId = -1L;<a
name="line.243"></a>
+<span class="sourceLineNo">244</span> closed = true;<a
name="line.244"></a>
+<span class="sourceLineNo">245</span> // Implied that no results
were returned back, either.<a name="line.245"></a>
+<span class="sourceLineNo">246</span> return null;<a
name="line.246"></a>
+<span class="sourceLineNo">247</span> }<a name="line.247"></a>
+<span class="sourceLineNo">248</span> // moreResultsInRegion
explicitly defines when a RS may choose to terminate a batch due<a
name="line.248"></a>
+<span class="sourceLineNo">249</span> // to size or quantity of
results in the response.<a name="line.249"></a>
+<span class="sourceLineNo">250</span> if
(response.hasMoreResultsInRegion()) {<a name="line.250"></a>
+<span class="sourceLineNo">251</span> // Set what the RS said<a
name="line.251"></a>
+<span class="sourceLineNo">252</span>
setHasMoreResultsContext(true);<a name="line.252"></a>
+<span class="sourceLineNo">253</span>
setServerHasMoreResults(response.getMoreResultsInRegion());<a
name="line.253"></a>
+<span class="sourceLineNo">254</span> } else {<a
name="line.254"></a>
+<span class="sourceLineNo">255</span> // Server didn't respond
whether it has more results or not.<a name="line.255"></a>
+<span class="sourceLineNo">256</span>
setHasMoreResultsContext(false);<a name="line.256"></a>
+<span class="sourceLineNo">257</span> }<a name="line.257"></a>
+<span class="sourceLineNo">258</span> } catch (ServiceException se)
{<a name="line.258"></a>
+<span class="sourceLineNo">259</span> throw
ProtobufUtil.getRemoteException(se);<a name="line.259"></a>
+<span class="sourceLineNo">260</span> }<a name="line.260"></a>
+<span class="sourceLineNo">261</span> updateResultsMetrics(rrs);<a
name="line.261"></a>
+<span class="sourceLineNo">262</span> } catch (IOException e) {<a
name="line.262"></a>
+<span class="sourceLineNo">263</span> if (logScannerActivity) {<a
name="line.263"></a>
+<span class="sourceLineNo">264</span> LOG.info("Got exception
making request " + TextFormat.shortDebugString(request)<a name="line.264"></a>
+<span class="sourceLineNo">265</span> + " to " + getLocation(),
e);<a name="line.265"></a>
+<span class="sourceLineNo">266</span> }<a name="line.266"></a>
+<span class="sourceLineNo">267</span> IOException ioe = e;<a
name="line.267"></a>
+<span class="sourceLineNo">268</span> if (e instanceof
RemoteException) {<a name="line.268"></a>
+<span class="sourceLineNo">269</span> ioe = ((RemoteException)
e).unwrapRemoteException();<a name="line.269"></a>
+<span class="sourceLineNo">270</span> }<a name="line.270"></a>
+<span class="sourceLineNo">271</span> if (logScannerActivity
&& (ioe instanceof UnknownScannerException)) {<a name="line.271"></a>
+<span class="sourceLineNo">272</span> try {<a name="line.272"></a>
+<span class="sourceLineNo">273</span> HRegionLocation location
=<a name="line.273"></a>
+<span class="sourceLineNo">274</span>
getConnection().relocateRegion(getTableName(), scan.getStartRow());<a
name="line.274"></a>
+<span class="sourceLineNo">275</span> LOG.info("Scanner=" +
scannerId<a name="line.275"></a>
+<span class="sourceLineNo">276</span> + " expired, current
region location is " + location.toString());<a name="line.276"></a>
+<span class="sourceLineNo">277</span> } catch (Throwable t) {<a
name="line.277"></a>
+<span class="sourceLineNo">278</span> LOG.info("Failed to
relocate region", t);<a name="line.278"></a>
+<span class="sourceLineNo">279</span> }<a name="line.279"></a>
+<span class="sourceLineNo">280</span> }<a name="line.280"></a>
+<span class="sourceLineNo">281</span> // The below convertion of
exceptions into DoNotRetryExceptions is a little strange.<a name="line.281"></a>
+<span class="sourceLineNo">282</span> // Why not just have these
exceptions implment DNRIOE you ask? Well, usually we want<a
name="line.282"></a>
+<span class="sourceLineNo">283</span> // ServerCallable#withRetries
to just retry when it gets these exceptions. In here in<a name="line.283"></a>
+<span class="sourceLineNo">284</span> // a scan when doing a next in
particular, we want to break out and get the scanner to<a name="line.284"></a>
+<span class="sourceLineNo">285</span> // reset itself up again.
Throwing a DNRIOE is how we signal this to happen (its ugly,<a
name="line.285"></a>
+<span class="sourceLineNo">286</span> // yeah and hard to follow and
in need of a refactor).<a name="line.286"></a>
+<span class="sourceLineNo">287</span> if (ioe instanceof
NotServingRegionException) {<a name="line.287"></a>
+<span class="sourceLineNo">288</span> // Throw a DNRE so that we
break out of cycle of calling NSRE<a name="line.288"></a>
+<span class="sourceLineNo">289</span> // when what we need is to
open scanner against new location.<a name="line.289"></a>
+<span class="sourceLineNo">290</span> // Attach NSRE to signal
client that it needs to re-setup scanner.<a name="line.290"></a>
+<span class="sourceLineNo">291</span> if (this.scanMetrics != null)
{<a name="line.291"></a>
+<span class="sourceLineNo">292</span>
this.scanMetrics.countOfNSRE.incrementAndGet();<a name="line.292"></a>
+<span class="sourceLineNo">293</span> }<a name="line.293"></a>
+<span class="sourceLineNo">294</span> throw new
DoNotRetryIOException("Resetting the scanner -- see exception cause", ioe);<a
name="line.294"></a>
+<span class="sourceLineNo">295</span> } else if (ioe instanceof
RegionServerStoppedException) {<a name="line.295"></a>
+<span class="sourceLineNo">296</span> // Throw a DNRE so that we
break out of cycle of the retries and instead go and<a name="line.296"></a>
+<span class="sourceLineNo">297</span> // open scanner against new
location.<a name="line.297"></a>
+<span class="sourceLineNo">298</span> throw new
DoNotRetryIOException("Resetting the scanner -- see exception cause", ioe);<a
name="line.298"></a>
+<span class="sourceLineNo">299</span> } else {<a name="line.299"></a>
+<span class="sourceLineNo">300</span> // The outer layers will
retry<a name="line.300"></a>
+<span class="sourceLineNo">301</span> throw ioe;<a
name="line.301"></a>
+<span class="sourceLineNo">302</span> }<a name="line.302"></a>
+<span class="sourceLineNo">303</span> }<a name="line.303"></a>
+<span class="sourceLineNo">304</span> return rrs;<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> return null;<a name="line.307"></a>
+<span class="sourceLineNo">308</span> }<a name="line.308"></a>
+<span class="sourceLineNo">309</span><a name="line.309"></a>
+<span class="sourceLineNo">310</span> /**<a name="line.310"></a>
+<span class="sourceLineNo">311</span> * @return true when the most recent
RPC response indicated that the response was a heartbeat<a name="line.311"></a>
+<span class="sourceLineNo">312</span> * message. Heartbeat messages
are sent back from the server when the processing of the<a name="line.312"></a>
+<span class="sourceLineNo">313</span> * scan request exceeds a
certain time threshold. Heartbeats allow the server to avoid<a
name="line.313"></a>
+<span class="sourceLineNo">314</span> * timeouts during long running
scan operations.<a name="line.314"></a>
+<span class="sourceLineNo">315</span> */<a name="line.315"></a>
+<span class="sourceLineNo">316</span> protected boolean isHeartbeatMessage()
{<a name="line.316"></a>
+<span class="sourceLineNo">317</span> return heartbeatMessage;<a
name="line.317"></a>
+<span class="sourceLineNo">318</span> }<a name="line.318"></a>
+<span class="sourceLineNo">319</span><a name="line.319"></a>
+<span class="sourceLineNo">320</span> protected void
setHeartbeatMessage(boolean heartbeatMessage) {<a name="line.320"></a>
+<span class="sourceLineNo">321</span> this.heartbeatMessage =
heartbeatMessage;<a name="line.321"></a>
+<span class="sourceLineNo">322</span> }<a name="line.322"></a>
+<span class="sourceLineNo">323</span><a name="line.323"></a>
+<span class="sourceLineNo">324</span> private void incRPCcallsMetrics() {<a
name="line.324"></a>
+<span class="sourceLineNo">325</span> if (this.scanMetrics == null) {<a
name="line.325"></a>
+<span class="sourceLineNo">326</span> return;<a name="line.326"></a>
+<span class="sourceLineNo">327</span> }<a name="line.327"></a>
+<span class="sourceLineNo">328</span>
this.scanMetrics.countOfRPCcalls.incrementAndGet();<a name="line.328"></a>
+<span class="sourceLineNo">329</span> if (isRegionServerRemote) {<a
name="line.329"></a>
+<span class="sourceLineNo">330</span>
this.scanMetrics.countOfRemoteRPCcalls.incrementAndGet();<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> protected void
updateResultsMetrics(Result[] rrs) {<a name="line.334"></a>
+<span class="sourceLineNo">335</span> if (this.scanMetrics == null || rrs
== null || rrs.length == 0) {<a name="line.335"></a>
+<span class="sourceLineNo">336</span> return;<a name="line.336"></a>
+<span class="sourceLineNo">337</span> }<a name="line.337"></a>
+<span class="sourceLineNo">338</span> long resultSize = 0;<a
name="line.338"></a>
+<span class="sourceLineNo">339</span> for (Result rr : rrs) {<a
name="line.339"></a>
+<span class="sourceLineNo">340</span> for (Cell cell : rr.rawCells()) {<a
name="line.340"></a>
+<span class="sourceLineNo">341</span> resultSize +=
CellUtil.estimatedSerializedSizeOf(cell);<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>
this.scanMetrics.countOfBytesInResults.addAndGet(resultSize);<a
name="line.344"></a>
+<span class="sourceLineNo">345</span> if (isRegionServerRemote) {<a
name="line.345"></a>
+<span class="sourceLineNo">346</span>
this.scanMetrics.countOfBytesInRemoteResults.addAndGet(resultSize);<a
name="line.346"></a>
+<span class="sourceLineNo">347</span> }<a name="line.347"></a>
+<span class="sourceLineNo">348</span> }<a name="line.348"></a>
+<span class="sourceLineNo">349</span><a name="line.349"></a>
+<span class="sourceLineNo">350</span> /**<a name="line.350"></a>
+<span class="sourceLineNo">351</span> * Use the scan metrics returned by the
server to add to the identically named counters in the<a name="line.351"></a>
+<span class="sourceLineNo">352</span> * client side metrics. If a counter
does not exist with the same name as the server side metric,<a
name="line.352"></a>
+<span class="sourceLineNo">353</span> * the attempt to increase the counter
will fail.<a name="line.353"></a>
+<span class="sourceLineNo">354</span> * @param response<a
name="line.354"></a>
+<span class="sourceLineNo">355</span> */<a name="line.355"></a>
+<span class="sourceLineNo">356</span> private void
updateServerSideMetrics(ScanResponse response) {<a name="line.356"></a>
+<span class="sourceLineNo">357</span> if (this.scanMetrics == null ||
response == null || !response.hasScanMetrics()) return;<a name="line.357"></a>
+<span class="sourceLineNo">358</span><a name="line.358"></a>
+<span class="sourceLineNo">359</span> Map<String, Long> serverMetrics
= ResponseConverter.getScanMetrics(response);<a name="line.359"></a>
+<span class="sourceLineNo">360</span> for (Entry<String, Long> entry
: serverMetrics.entrySet()) {<a name="line.360"></a>
+<span class="sourceLineNo">361</span>
this.scanMetrics.addToCounter(entry.getKey(), entry.getValue());<a
name="line.361"></a>
+<span class="sourceLineNo">362</span> }<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> private void close() {<a
name="line.365"></a>
+<span class="sourceLineNo">366</span> if (this.scannerId == -1L) {<a
name="line.366"></a>
+<span class="sourceLineNo">367</span> return;<a name="line.367"></a>
+<span class="sourceLineNo">368</span> }<a name="line.368"></a>
+<span class="sourceLineNo">369</span> try {<a name="line.369"></a>
+<span class="sourceLineNo">370</span> incRPCcallsMetrics();<a
name="line.370"></a>
+<span class="sourceLineNo">371</span> ScanRequest request =<a
name="line.371"></a>
+<span class="sourceLineNo">372</span>
RequestConverter.buildScanRequest(this.scannerId, 0, true, this.scanMetrics !=
null);<a name="line.372"></a>
+<span class="sourceLineNo">373</span> try {<a name="line.373"></a>
+<span class="sourceLineNo">374</span> getStub().scan(null, request);<a
name="line.374"></a>
+<span class="sourceLineNo">375</span> } catch (ServiceException se) {<a
name="line.375"></a>
+<span class="sourceLineNo">376</span> throw
ProtobufUtil.getRemoteException(se);<a name="line.376"></a>
+<span class="sourceLineNo">377</span> }<a name="line.377"></a>
+<span class="sourceLineNo">378</span> } catch (IOException e) {<a
name="line.378"></a>
+<span class="sourceLineNo">379</span> LOG.warn("Ignore, probably already
closed", e);<a name="line.379"></a>
+<span class="sourceLineNo">380</span> }<a name="line.380"></a>
+<span class="sourceLineNo">381</span> this.scannerId = -1L;<a
name="line.381"></a>
+<span class="sourceLineNo">382</span> }<a name="line.382"></a>
+<span class="sourceLineNo">383</span><a name="line.383"></a>
+<span class="sourceLineNo">384</span> protected long openScanner() throws
IOException {<a name="line.384"></a>
+<span class="sourceLineNo">385</span> incRPCcallsMetrics();<a
name="line.385"></a>
+<span class="sourceLineNo">386</span> ScanRequest request =<a
name="line.386"></a>
+<span class="sourceLineNo">387</span>
RequestConverter.buildScanRequest(<a name="line.387"></a>
+<span class="sourceLineNo">388</span>
getLocation().getRegionInfo().getRegionName(),<a name="line.388"></a>
+<span class="sourceLineNo">389</span> this.scan, 0, false);<a
name="line.389"></a>
+<span class="sourceLineNo">390</span> try {<a name="line.390"></a>
+<span class="sourceLineNo">391</span> ScanResponse response =
getStub().scan(null, request);<a name="line.391"></a>
+<span class="sourceLineNo">392</span> long id =
response.getScannerId();<a name="line.392"></a>
+<span class="sourceLineNo">393</span> if (logScannerActivity) {<a
name="line.393"></a>
+<span class="sourceLineNo">394</span> LOG.info("Open scanner=" + id + "
for scan=" + scan.toString()<a name="line.394"></a>
+<span class="sourceLineNo">395</span> + " on region " +
getLocation().toString());<a name="line.395"></a>
+<span class="sourceLineNo">396</span> }<a name="line.396"></a>
+<span class="sourceLineNo">397</span> return id;<a name="line.397"></a>
+<span class="sourceLineNo">398</span> } catch (ServiceException se) {<a
name="line.398"></a>
+<span class="sourceLineNo">399</span> throw
ProtobufUtil.getRemoteException(se);<a name="line.399"></a>
+<span class="sourceLineNo">400</span> }<a name="line.400"></a>
+<span class="sourceLineNo">401</span> }<a name="line.401"></a>
+<span class="sourceLineNo">402</span><a name="line.402"></a>
+<span class="sourceLineNo">403</span> protected Scan getScan() {<a
name="line.403"></a>
+<span class="sourceLineNo">404</span> return scan;<a name="line.404"></a>
+<span class="sourceLineNo">405</span> }<a name="line.405"></a>
+<span class="sourceLineNo">406</span><a name="line.406"></a>
+<span class="sourceLineNo">407</span> /**<a name="line.407"></a>
+<span class="sourceLineNo">408</span> * Call this when the next invocation
of call should close the scanner<a name="line.408"></a>
+<span class="sourceLineNo">409</span> */<a name="line.409"></a>
+<span class="sourceLineNo">410</span> public void setClose() {<a
name="line.410"></a>
+<span class="sourceLineNo">411</span> this.closed = true;<a
name="line.411"></a>
+<span class="sourceLineNo">412</span> }<a name="line.412"></a>
+<span class="sourceLineNo">413</span><a name="line.413"></a>
+<span class="sourceLineNo">414</span> /**<a name="line.414"></a>
+<span class="sourceLineNo">415</span> * Indicate whether we make a call only
to renew the lease, but without affected the scanner in<a name="line.415"></a>
+<span class="sourceLineNo">416</span> * any other way.<a name="line.416"></a>
+<span class="sourceLineNo">417</span> * @param val true if only the lease
should be renewed<a name="line.417"></a>
+<span class="sourceLineNo">418</span> */<a name="line.418"></a>
+<span class="sourceLineNo">419</span> public void setRenew(boolean val) {<a
name="line.419"></a>
+<span class="sourceLineNo">420</span> this.renew = val;<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> * @return the HRegionInfo for the
current region<a name="line.424"></a>
+<span class="sourceLineNo">425</span> */<a name="line.425"></a>
+<span class="sourceLineNo">426</span> @Override<a name="line.426"></a>
+<span class="sourceLineNo">427</span> public HRegionInfo getHRegionInfo() {<a
name="line.427"></a>
+<span class="sourceLineNo">428</span> if (!instantiated) {<a
name="line.428"></a>
+<span class="sourceLineNo">429</span> return null;<a name="line.429"></a>
+<span class="sourceLineNo">430</span> }<a name="line.430"></a>
+<span class="sourceLineNo">431</span> return
getLocation().getRegionInfo();<a name="line.431"></a>
+<span class="sourceLineNo">432</span> }<a name="line.432"></a>
+<span class="sourceLineNo">433</span><a name="line.433"></a>
+<span class="sourceLineNo">434</span> /**<a name="line.434"></a>
+<span class="sourceLineNo">435</span> * Get the number of rows that will be
fetched on next<a name="line.435"></a>
+<span class="sourceLineNo">436</span> * @return the number of rows for
caching<a name="line.436"></a>
+<span class="sourceLineNo">437</span> */<a name="line.437"></a>
+<span class="sourceLineNo">438</span> public int getCaching() {<a
name="line.438"></a>
+<span class="sourceLineNo">439</span> return caching;<a name="line.439"></a>
+<span class="sourceLineNo">440</span> }<a name="line.440"></a>
+<span class="sourceLineNo">441</span><a name="line.441"></a>
+<span class="sourceLineNo">442</span> @Override<a name="line.442"></a>
+<span class="sourceLineNo">443</span> public ClusterConnection
getConnection() {<a name="line.443"></a>
+<span class="sourceLineNo">444</span> return cConnection;<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> /**<a name="line.447"></a>
+<span class="sourceLineNo">448</span> * Set the number of rows that will be
fetched on next<a name="line.448"></a>
+<span class="sourceLineNo">449</span> * @param caching the number of rows
for caching<a name="line.449"></a>
+<span class="sourceLineNo">450</span> */<a name="line.450"></a>
+<span class="sourceLineNo">451</span> public void setCaching(int caching) {<a
name="line.451"></a>
+<span class="sourceLineNo">452</span> this.caching = caching;<a
name="line.452"></a>
+<span class="sourceLineNo">453</span> }<a name="line.453"></a>
+<span class="sourceLineNo">454</span><a name="line.454"></a>
+<span class="sourceLineNo">455</span> public ScannerCallable
getScannerCallableForReplica(int id) {<a name="line.455"></a>
+<span class="sourceLineNo">456</span> ScannerCallable s = new
ScannerCallable(this.getConnection(), this.tableName,<a name="line.456"></a>
+<span class="sourceLineNo">457</span> this.getScan(), this.scanMetrics,
controllerFactory, id);<a name="line.457"></a>
+<span class="sourceLineNo">458</span> s.setCaching(this.caching);<a
name="line.458"></a>
+<span class="sourceLineNo">459</span> return s;<a name="line.459"></a>
+<span class="sourceLineNo">460</span> }<a name="line.460"></a>
+<span class="sourceLineNo">461</span><a name="line.461"></a>
+<span class="sourceLineNo">462</span> /**<a name="line.462"></a>
+<span class="sourceLineNo">463</span> * Should the client attempt to fetch
more results from this region<a name="line.463"></a>
+<span class="sourceLineNo">464</span> * @return True if the client should
attempt to fetch more results, false otherwise.<a name="line.464"></a>
+<span class="sourceLineNo">465</span> */<a name="line.465"></a>
+<span class="sourceLineNo">466</span> protected boolean
getServerHasMoreResults() {<a name="line.466"></a>
+<span class="sourceLineNo">467</span> assert serverHasMoreResultsContext;<a
name="line.467"></a>
+<span class="sourceLineNo">468</span> return this.serverHasMoreResults;<a
name="line.468"></a>
+<span class="sourceLineNo">469</span> }<a name="line.469"></a>
+<span class="sourceLineNo">470</span><a name="line.470"></a>
+<span class="sourceLineNo">471</span> protected void
setServerHasMoreResults(boolean serverHasMoreResults) {<a name="line.471"></a>
+<span class="sourceLineNo">472</span> this.serverHasMoreResults =
serverHasMoreResults;<a name="line.472"></a>
+<span class="sourceLineNo">473</span> }<a name="line.473"></a>
+<span class="sourceLineNo">474</span><a name="line.474"></a>
+<span class="sourceLineNo">475</span> /**<a name="line.475"></a>
+<span class="sourceLineNo">476</span> * Did the server respond with
information about whether more results might exist.<a name="line.476"></a>
+<span class="sourceLineNo">477</span> * Not guaranteed to respond with older
server versions<a name="line.477"></a>
+<span class="sourceLineNo">478</span> * @return True if the server responded
with information about more results.<a name="line.478"></a>
+<span class="sourceLineNo">479</span> */<a name="line.479"></a>
+<span class="sourceLineNo">480</span> protected boolean
hasMoreResultsContext() {<a name="line.480"></a>
+<span class="sourceLineNo">481</span> return serverHasMoreResultsContext;<a
name="line.481"></a>
+<span class="sourceLineNo">482</span> }<a name="line.482"></a>
+<span class="sourceLineNo">483</span><a name="line.483"></a>
+<span class="sourceLineNo">484</span> protected void
setHasMoreResultsContext(boolean serverHasMoreResultsContext) {<a
name="line.484"></a>
+<span class="sourceLineNo">485</span> this.serverHasMoreResultsContext =
serverHasMoreResultsContext;<a name="line.485"></a>
+<span class="sourceLineNo">486</span> }<a name="line.486"></a>
+<span class="sourceLineNo">487</span>}<a name="line.487"></a>