http://git-wip-us.apache.org/repos/asf/hbase-site/blob/3469cbc0/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html
----------------------------------------------------------------------
diff --git
a/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html
b/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html
index 594ef24..17d5c40 100644
---
a/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html
+++
b/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html
@@ -170,241 +170,242 @@
<span class="sourceLineNo">162</span> }<a name="line.162"></a>
<span class="sourceLineNo">163</span><a name="line.163"></a>
<span class="sourceLineNo">164</span> /**<a name="line.164"></a>
-<span class="sourceLineNo">165</span> * Add a remote rpc. Be sure to check
result for successful add.<a name="line.165"></a>
+<span class="sourceLineNo">165</span> * Add a remote rpc.<a
name="line.165"></a>
<span class="sourceLineNo">166</span> * @param key the node identifier<a
name="line.166"></a>
-<span class="sourceLineNo">167</span> * @return True if we successfully
added the operation.<a name="line.167"></a>
-<span class="sourceLineNo">168</span> */<a name="line.168"></a>
-<span class="sourceLineNo">169</span> public boolean addOperationToNode(final
TRemote key, RemoteProcedure rp) {<a name="line.169"></a>
+<span class="sourceLineNo">167</span> */<a name="line.167"></a>
+<span class="sourceLineNo">168</span> public void addOperationToNode(final
TRemote key, RemoteProcedure rp)<a name="line.168"></a>
+<span class="sourceLineNo">169</span> throws
NullTargetServerDispatchException, NoServerDispatchException,
NoNodeDispatchException {<a name="line.169"></a>
<span class="sourceLineNo">170</span> if (key == null) {<a
name="line.170"></a>
-<span class="sourceLineNo">171</span> // Key is remote server name. Be
careful. It could have been nulled by a concurrent<a name="line.171"></a>
-<span class="sourceLineNo">172</span> // ServerCrashProcedure shutting
down outstanding RPC requests. See remoteCallFailed.<a name="line.172"></a>
-<span class="sourceLineNo">173</span> return false;<a name="line.173"></a>
-<span class="sourceLineNo">174</span> }<a name="line.174"></a>
-<span class="sourceLineNo">175</span> assert key != null : "found null key
for node";<a name="line.175"></a>
-<span class="sourceLineNo">176</span> BufferNode node = nodeMap.get(key);<a
name="line.176"></a>
-<span class="sourceLineNo">177</span> if (node == null) {<a
name="line.177"></a>
-<span class="sourceLineNo">178</span> return false;<a name="line.178"></a>
-<span class="sourceLineNo">179</span> }<a name="line.179"></a>
-<span class="sourceLineNo">180</span> node.add(rp);<a name="line.180"></a>
-<span class="sourceLineNo">181</span> // Check our node still in the map;
could have been removed by #removeNode.<a name="line.181"></a>
-<span class="sourceLineNo">182</span> return nodeMap.containsValue(node);<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> /**<a name="line.185"></a>
-<span class="sourceLineNo">186</span> * Remove a remote node<a
name="line.186"></a>
-<span class="sourceLineNo">187</span> * @param key the node identifier<a
name="line.187"></a>
-<span class="sourceLineNo">188</span> */<a name="line.188"></a>
-<span class="sourceLineNo">189</span> public boolean removeNode(final TRemote
key) {<a name="line.189"></a>
-<span class="sourceLineNo">190</span> final BufferNode node =
nodeMap.remove(key);<a name="line.190"></a>
-<span class="sourceLineNo">191</span> if (node == null) return false;<a
name="line.191"></a>
-<span class="sourceLineNo">192</span> node.abortOperationsInQueue();<a
name="line.192"></a>
-<span class="sourceLineNo">193</span> return true;<a name="line.193"></a>
-<span class="sourceLineNo">194</span> }<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> // Task Helpers<a name="line.197"></a>
-<span class="sourceLineNo">198</span> //
============================================================================================<a
name="line.198"></a>
-<span class="sourceLineNo">199</span> protected Future<Void>
submitTask(Callable<Void> task) {<a name="line.199"></a>
-<span class="sourceLineNo">200</span> return threadPool.submit(task);<a
name="line.200"></a>
-<span class="sourceLineNo">201</span> }<a name="line.201"></a>
-<span class="sourceLineNo">202</span><a name="line.202"></a>
-<span class="sourceLineNo">203</span> protected Future<Void>
submitTask(Callable<Void> task, long delay, TimeUnit unit) {<a
name="line.203"></a>
-<span class="sourceLineNo">204</span> final FutureTask<Void>
futureTask = new FutureTask(task);<a name="line.204"></a>
-<span class="sourceLineNo">205</span> timeoutExecutor.add(new
DelayedTask(futureTask, delay, unit));<a name="line.205"></a>
-<span class="sourceLineNo">206</span> return futureTask;<a
name="line.206"></a>
-<span class="sourceLineNo">207</span> }<a name="line.207"></a>
-<span class="sourceLineNo">208</span><a name="line.208"></a>
-<span class="sourceLineNo">209</span> protected abstract void
remoteDispatch(TRemote key, Set<RemoteProcedure> operations);<a
name="line.209"></a>
-<span class="sourceLineNo">210</span> protected abstract void
abortPendingOperations(TRemote key, Set<RemoteProcedure> operations);<a
name="line.210"></a>
-<span class="sourceLineNo">211</span><a name="line.211"></a>
-<span class="sourceLineNo">212</span> /**<a name="line.212"></a>
-<span class="sourceLineNo">213</span> * Data structure with reference to
remote operation.<a name="line.213"></a>
-<span class="sourceLineNo">214</span> */<a name="line.214"></a>
-<span class="sourceLineNo">215</span> public static abstract class
RemoteOperation {<a name="line.215"></a>
-<span class="sourceLineNo">216</span> private final RemoteProcedure
remoteProcedure;<a name="line.216"></a>
-<span class="sourceLineNo">217</span><a name="line.217"></a>
-<span class="sourceLineNo">218</span> protected RemoteOperation(final
RemoteProcedure remoteProcedure) {<a name="line.218"></a>
-<span class="sourceLineNo">219</span> this.remoteProcedure =
remoteProcedure;<a name="line.219"></a>
-<span class="sourceLineNo">220</span> }<a name="line.220"></a>
-<span class="sourceLineNo">221</span><a name="line.221"></a>
-<span class="sourceLineNo">222</span> public RemoteProcedure
getRemoteProcedure() {<a name="line.222"></a>
-<span class="sourceLineNo">223</span> return remoteProcedure;<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><a name="line.226"></a>
-<span class="sourceLineNo">227</span> /**<a name="line.227"></a>
-<span class="sourceLineNo">228</span> * Remote procedure reference.<a
name="line.228"></a>
-<span class="sourceLineNo">229</span> */<a name="line.229"></a>
-<span class="sourceLineNo">230</span> public interface
RemoteProcedure<TEnv, TRemote> {<a name="line.230"></a>
-<span class="sourceLineNo">231</span> /**<a name="line.231"></a>
-<span class="sourceLineNo">232</span> * For building the remote
operation.<a name="line.232"></a>
-<span class="sourceLineNo">233</span> */<a name="line.233"></a>
-<span class="sourceLineNo">234</span> RemoteOperation remoteCallBuild(TEnv
env, TRemote remote);<a name="line.234"></a>
-<span class="sourceLineNo">235</span><a name="line.235"></a>
-<span class="sourceLineNo">236</span> /**<a name="line.236"></a>
-<span class="sourceLineNo">237</span> * Called when the executeProcedure
call is failed.<a name="line.237"></a>
-<span class="sourceLineNo">238</span> */<a name="line.238"></a>
-<span class="sourceLineNo">239</span> void remoteCallFailed(TEnv env,
TRemote remote, IOException exception);<a name="line.239"></a>
-<span class="sourceLineNo">240</span><a name="line.240"></a>
-<span class="sourceLineNo">241</span> /**<a name="line.241"></a>
-<span class="sourceLineNo">242</span> * Called when RS tells the remote
procedure is succeeded through the<a name="line.242"></a>
-<span class="sourceLineNo">243</span> * {@code reportProcedureDone}
method.<a name="line.243"></a>
-<span class="sourceLineNo">244</span> */<a name="line.244"></a>
-<span class="sourceLineNo">245</span> void remoteOperationCompleted(TEnv
env);<a name="line.245"></a>
-<span class="sourceLineNo">246</span><a name="line.246"></a>
-<span class="sourceLineNo">247</span> /**<a name="line.247"></a>
-<span class="sourceLineNo">248</span> * Called when RS tells the remote
procedure is failed through the {@code reportProcedureDone}<a
name="line.248"></a>
-<span class="sourceLineNo">249</span> * method.<a name="line.249"></a>
-<span class="sourceLineNo">250</span> */<a name="line.250"></a>
-<span class="sourceLineNo">251</span> void remoteOperationFailed(TEnv env,
RemoteProcedureException error);<a name="line.251"></a>
-<span class="sourceLineNo">252</span> }<a name="line.252"></a>
-<span class="sourceLineNo">253</span><a name="line.253"></a>
-<span class="sourceLineNo">254</span> /**<a name="line.254"></a>
-<span class="sourceLineNo">255</span> * Account of what procedures are
running on remote node.<a name="line.255"></a>
-<span class="sourceLineNo">256</span> * @param <TEnv><a
name="line.256"></a>
-<span class="sourceLineNo">257</span> * @param <TRemote><a
name="line.257"></a>
-<span class="sourceLineNo">258</span> */<a name="line.258"></a>
-<span class="sourceLineNo">259</span> public interface RemoteNode<TEnv,
TRemote> {<a name="line.259"></a>
-<span class="sourceLineNo">260</span> TRemote getKey();<a
name="line.260"></a>
-<span class="sourceLineNo">261</span> void add(RemoteProcedure<TEnv,
TRemote> operation);<a name="line.261"></a>
-<span class="sourceLineNo">262</span> void dispatch();<a
name="line.262"></a>
-<span class="sourceLineNo">263</span> }<a name="line.263"></a>
-<span class="sourceLineNo">264</span><a name="line.264"></a>
-<span class="sourceLineNo">265</span> protected
ArrayListMultimap<Class<?>, RemoteOperation>
buildAndGroupRequestByType(final TEnv env,<a name="line.265"></a>
-<span class="sourceLineNo">266</span> final TRemote remote, final
Set<RemoteProcedure> remoteProcedures) {<a name="line.266"></a>
-<span class="sourceLineNo">267</span> final
ArrayListMultimap<Class<?>, RemoteOperation> requestByType =
ArrayListMultimap.create();<a name="line.267"></a>
-<span class="sourceLineNo">268</span> for (RemoteProcedure proc:
remoteProcedures) {<a name="line.268"></a>
-<span class="sourceLineNo">269</span> RemoteOperation operation =
proc.remoteCallBuild(env, remote);<a name="line.269"></a>
-<span class="sourceLineNo">270</span>
requestByType.put(operation.getClass(), operation);<a name="line.270"></a>
-<span class="sourceLineNo">271</span> }<a name="line.271"></a>
-<span class="sourceLineNo">272</span> return requestByType;<a
name="line.272"></a>
-<span class="sourceLineNo">273</span> }<a name="line.273"></a>
-<span class="sourceLineNo">274</span><a name="line.274"></a>
-<span class="sourceLineNo">275</span> protected <T extends
RemoteOperation> List<T> fetchType(<a name="line.275"></a>
-<span class="sourceLineNo">276</span> final
ArrayListMultimap<Class<?>, RemoteOperation> requestByType, final
Class<T> type) {<a name="line.276"></a>
-<span class="sourceLineNo">277</span> return
(List<T>)requestByType.removeAll(type);<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> //
============================================================================================<a
name="line.280"></a>
-<span class="sourceLineNo">281</span> // Timeout Helpers<a
name="line.281"></a>
-<span class="sourceLineNo">282</span> //
============================================================================================<a
name="line.282"></a>
-<span class="sourceLineNo">283</span> private final class
TimeoutExecutorThread extends Thread {<a name="line.283"></a>
-<span class="sourceLineNo">284</span> private final
DelayQueue<DelayedWithTimeout> queue = new
DelayQueue<DelayedWithTimeout>();<a name="line.284"></a>
-<span class="sourceLineNo">285</span><a name="line.285"></a>
-<span class="sourceLineNo">286</span> public TimeoutExecutorThread() {<a
name="line.286"></a>
-<span class="sourceLineNo">287</span>
super("ProcedureDispatcherTimeoutThread");<a name="line.287"></a>
-<span class="sourceLineNo">288</span> }<a name="line.288"></a>
-<span class="sourceLineNo">289</span><a name="line.289"></a>
-<span class="sourceLineNo">290</span> @Override<a name="line.290"></a>
-<span class="sourceLineNo">291</span> public void run() {<a
name="line.291"></a>
-<span class="sourceLineNo">292</span> while (running.get()) {<a
name="line.292"></a>
-<span class="sourceLineNo">293</span> final DelayedWithTimeout task =
DelayedUtil.takeWithoutInterrupt(queue);<a name="line.293"></a>
-<span class="sourceLineNo">294</span> if (task == null || task ==
DelayedUtil.DELAYED_POISON) {<a name="line.294"></a>
-<span class="sourceLineNo">295</span> // the executor may be shutting
down, and the task is just the shutdown request<a name="line.295"></a>
-<span class="sourceLineNo">296</span> continue;<a name="line.296"></a>
-<span class="sourceLineNo">297</span> }<a name="line.297"></a>
-<span class="sourceLineNo">298</span> if (task instanceof DelayedTask)
{<a name="line.298"></a>
-<span class="sourceLineNo">299</span>
threadPool.execute(((DelayedTask)task).getObject());<a name="line.299"></a>
-<span class="sourceLineNo">300</span> } else {<a name="line.300"></a>
-<span class="sourceLineNo">301</span>
((BufferNode)task).dispatch();<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> }<a name="line.304"></a>
-<span class="sourceLineNo">305</span><a name="line.305"></a>
-<span class="sourceLineNo">306</span> public void add(final
DelayedWithTimeout delayed) {<a name="line.306"></a>
-<span class="sourceLineNo">307</span> queue.add(delayed);<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> public void remove(final
DelayedWithTimeout delayed) {<a name="line.310"></a>
-<span class="sourceLineNo">311</span> queue.remove(delayed);<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> public void sendStopSignal() {<a
name="line.314"></a>
-<span class="sourceLineNo">315</span>
queue.add(DelayedUtil.DELAYED_POISON);<a name="line.315"></a>
-<span class="sourceLineNo">316</span> }<a name="line.316"></a>
-<span class="sourceLineNo">317</span><a name="line.317"></a>
-<span class="sourceLineNo">318</span> public void awaitTermination() {<a
name="line.318"></a>
-<span class="sourceLineNo">319</span> try {<a name="line.319"></a>
-<span class="sourceLineNo">320</span> final long startTime =
EnvironmentEdgeManager.currentTime();<a name="line.320"></a>
-<span class="sourceLineNo">321</span> for (int i = 0; isAlive(); ++i)
{<a name="line.321"></a>
-<span class="sourceLineNo">322</span> sendStopSignal();<a
name="line.322"></a>
-<span class="sourceLineNo">323</span> join(250);<a
name="line.323"></a>
-<span class="sourceLineNo">324</span> if (i > 0 && (i % 8)
== 0) {<a name="line.324"></a>
-<span class="sourceLineNo">325</span> LOG.warn("Waiting termination
of thread " + getName() + ", " +<a name="line.325"></a>
-<span class="sourceLineNo">326</span>
StringUtils.humanTimeDiff(EnvironmentEdgeManager.currentTime() - startTime));<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> } catch (InterruptedException e)
{<a name="line.329"></a>
-<span class="sourceLineNo">330</span> LOG.warn(getName() + " join wait
got interrupted", e);<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><a name="line.334"></a>
-<span class="sourceLineNo">335</span> //
============================================================================================<a
name="line.335"></a>
-<span class="sourceLineNo">336</span> // Internals Helpers<a
name="line.336"></a>
-<span class="sourceLineNo">337</span> //
============================================================================================<a
name="line.337"></a>
-<span class="sourceLineNo">338</span><a name="line.338"></a>
-<span class="sourceLineNo">339</span> /**<a name="line.339"></a>
-<span class="sourceLineNo">340</span> * Node that contains a set of
RemoteProcedures<a name="line.340"></a>
-<span class="sourceLineNo">341</span> */<a name="line.341"></a>
-<span class="sourceLineNo">342</span> protected final class BufferNode
extends DelayedContainerWithTimestamp<TRemote><a name="line.342"></a>
-<span class="sourceLineNo">343</span> implements RemoteNode<TEnv,
TRemote> {<a name="line.343"></a>
-<span class="sourceLineNo">344</span> private Set<RemoteProcedure>
operations;<a name="line.344"></a>
-<span class="sourceLineNo">345</span><a name="line.345"></a>
-<span class="sourceLineNo">346</span> protected BufferNode(final TRemote
key) {<a name="line.346"></a>
-<span class="sourceLineNo">347</span> super(key, 0);<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> @Override<a name="line.350"></a>
-<span class="sourceLineNo">351</span> public TRemote getKey() {<a
name="line.351"></a>
-<span class="sourceLineNo">352</span> return getObject();<a
name="line.352"></a>
-<span class="sourceLineNo">353</span> }<a name="line.353"></a>
-<span class="sourceLineNo">354</span><a name="line.354"></a>
-<span class="sourceLineNo">355</span> @Override<a name="line.355"></a>
-<span class="sourceLineNo">356</span> public synchronized void add(final
RemoteProcedure operation) {<a name="line.356"></a>
-<span class="sourceLineNo">357</span> if (this.operations == null) {<a
name="line.357"></a>
-<span class="sourceLineNo">358</span> this.operations = new
HashSet<>();<a name="line.358"></a>
-<span class="sourceLineNo">359</span>
setTimeout(EnvironmentEdgeManager.currentTime() + operationDelay);<a
name="line.359"></a>
-<span class="sourceLineNo">360</span> timeoutExecutor.add(this);<a
name="line.360"></a>
-<span class="sourceLineNo">361</span> }<a name="line.361"></a>
-<span class="sourceLineNo">362</span> this.operations.add(operation);<a
name="line.362"></a>
-<span class="sourceLineNo">363</span> if (this.operations.size() >
queueMaxSize) {<a name="line.363"></a>
-<span class="sourceLineNo">364</span> timeoutExecutor.remove(this);<a
name="line.364"></a>
-<span class="sourceLineNo">365</span> dispatch();<a name="line.365"></a>
-<span class="sourceLineNo">366</span> }<a name="line.366"></a>
-<span class="sourceLineNo">367</span> }<a name="line.367"></a>
-<span class="sourceLineNo">368</span><a name="line.368"></a>
-<span class="sourceLineNo">369</span> @Override<a name="line.369"></a>
-<span class="sourceLineNo">370</span> public synchronized void dispatch()
{<a name="line.370"></a>
-<span class="sourceLineNo">371</span> if (operations != null) {<a
name="line.371"></a>
-<span class="sourceLineNo">372</span> remoteDispatch(getKey(),
operations);<a name="line.372"></a>
-<span class="sourceLineNo">373</span> this.operations = null;<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><a name="line.376"></a>
-<span class="sourceLineNo">377</span> public synchronized void
abortOperationsInQueue() {<a name="line.377"></a>
-<span class="sourceLineNo">378</span> if (operations != null) {<a
name="line.378"></a>
-<span class="sourceLineNo">379</span> abortPendingOperations(getKey(),
operations);<a name="line.379"></a>
-<span class="sourceLineNo">380</span> this.operations = null;<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><a name="line.383"></a>
-<span class="sourceLineNo">384</span> @Override<a name="line.384"></a>
-<span class="sourceLineNo">385</span> public String toString() {<a
name="line.385"></a>
-<span class="sourceLineNo">386</span> return super.toString() + ",
operations=" + this.operations;<a name="line.386"></a>
-<span class="sourceLineNo">387</span> }<a name="line.387"></a>
-<span class="sourceLineNo">388</span> }<a name="line.388"></a>
-<span class="sourceLineNo">389</span><a name="line.389"></a>
-<span class="sourceLineNo">390</span> /**<a name="line.390"></a>
-<span class="sourceLineNo">391</span> * Delayed object that holds a
FutureTask.<a name="line.391"></a>
-<span class="sourceLineNo">392</span> * used to submit something later to
the thread-pool.<a name="line.392"></a>
-<span class="sourceLineNo">393</span> */<a name="line.393"></a>
-<span class="sourceLineNo">394</span> private static final class DelayedTask
extends DelayedContainerWithTimestamp<FutureTask<Void>> {<a
name="line.394"></a>
-<span class="sourceLineNo">395</span> public DelayedTask(final
FutureTask<Void> task, final long delay, final TimeUnit unit) {<a
name="line.395"></a>
-<span class="sourceLineNo">396</span> super(task,
EnvironmentEdgeManager.currentTime() + unit.toMillis(delay));<a
name="line.396"></a>
-<span class="sourceLineNo">397</span> }<a name="line.397"></a>
-<span class="sourceLineNo">398</span> }<a name="line.398"></a>
-<span class="sourceLineNo">399</span>}<a name="line.399"></a>
+<span class="sourceLineNo">171</span> throw new
NullTargetServerDispatchException(rp.toString());<a name="line.171"></a>
+<span class="sourceLineNo">172</span> }<a name="line.172"></a>
+<span class="sourceLineNo">173</span> BufferNode node = nodeMap.get(key);<a
name="line.173"></a>
+<span class="sourceLineNo">174</span> if (node == null) {<a
name="line.174"></a>
+<span class="sourceLineNo">175</span> // If null here, it means node has
been removed because it crashed. This happens when server<a name="line.175"></a>
+<span class="sourceLineNo">176</span> // is expired in ServerManager.
ServerCrashProcedure may or may not have run.<a name="line.176"></a>
+<span class="sourceLineNo">177</span> throw new
NoServerDispatchException(key.toString() + "; " + rp.toString());<a
name="line.177"></a>
+<span class="sourceLineNo">178</span> }<a name="line.178"></a>
+<span class="sourceLineNo">179</span> node.add(rp);<a name="line.179"></a>
+<span class="sourceLineNo">180</span> // Check our node still in the map;
could have been removed by #removeNode.<a name="line.180"></a>
+<span class="sourceLineNo">181</span> if (!nodeMap.containsValue(node)) {<a
name="line.181"></a>
+<span class="sourceLineNo">182</span> throw new
NoNodeDispatchException(key.toString() + "; " + rp.toString());<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><a name="line.185"></a>
+<span class="sourceLineNo">186</span> /**<a name="line.186"></a>
+<span class="sourceLineNo">187</span> * Remove a remote node<a
name="line.187"></a>
+<span class="sourceLineNo">188</span> * @param key the node identifier<a
name="line.188"></a>
+<span class="sourceLineNo">189</span> */<a name="line.189"></a>
+<span class="sourceLineNo">190</span> public boolean removeNode(final TRemote
key) {<a name="line.190"></a>
+<span class="sourceLineNo">191</span> final BufferNode node =
nodeMap.remove(key);<a name="line.191"></a>
+<span class="sourceLineNo">192</span> if (node == null) return false;<a
name="line.192"></a>
+<span class="sourceLineNo">193</span> node.abortOperationsInQueue();<a
name="line.193"></a>
+<span class="sourceLineNo">194</span> return true;<a name="line.194"></a>
+<span class="sourceLineNo">195</span> }<a name="line.195"></a>
+<span class="sourceLineNo">196</span><a name="line.196"></a>
+<span class="sourceLineNo">197</span> //
============================================================================================<a
name="line.197"></a>
+<span class="sourceLineNo">198</span> // Task Helpers<a name="line.198"></a>
+<span class="sourceLineNo">199</span> //
============================================================================================<a
name="line.199"></a>
+<span class="sourceLineNo">200</span> protected Future<Void>
submitTask(Callable<Void> task) {<a name="line.200"></a>
+<span class="sourceLineNo">201</span> return threadPool.submit(task);<a
name="line.201"></a>
+<span class="sourceLineNo">202</span> }<a name="line.202"></a>
+<span class="sourceLineNo">203</span><a name="line.203"></a>
+<span class="sourceLineNo">204</span> protected Future<Void>
submitTask(Callable<Void> task, long delay, TimeUnit unit) {<a
name="line.204"></a>
+<span class="sourceLineNo">205</span> final FutureTask<Void>
futureTask = new FutureTask(task);<a name="line.205"></a>
+<span class="sourceLineNo">206</span> timeoutExecutor.add(new
DelayedTask(futureTask, delay, unit));<a name="line.206"></a>
+<span class="sourceLineNo">207</span> return futureTask;<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> protected abstract void
remoteDispatch(TRemote key, Set<RemoteProcedure> operations);<a
name="line.210"></a>
+<span class="sourceLineNo">211</span> protected abstract void
abortPendingOperations(TRemote key, Set<RemoteProcedure> operations);<a
name="line.211"></a>
+<span class="sourceLineNo">212</span><a name="line.212"></a>
+<span class="sourceLineNo">213</span> /**<a name="line.213"></a>
+<span class="sourceLineNo">214</span> * Data structure with reference to
remote operation.<a name="line.214"></a>
+<span class="sourceLineNo">215</span> */<a name="line.215"></a>
+<span class="sourceLineNo">216</span> public static abstract class
RemoteOperation {<a name="line.216"></a>
+<span class="sourceLineNo">217</span> private final RemoteProcedure
remoteProcedure;<a name="line.217"></a>
+<span class="sourceLineNo">218</span><a name="line.218"></a>
+<span class="sourceLineNo">219</span> protected RemoteOperation(final
RemoteProcedure remoteProcedure) {<a name="line.219"></a>
+<span class="sourceLineNo">220</span> this.remoteProcedure =
remoteProcedure;<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> public RemoteProcedure
getRemoteProcedure() {<a name="line.223"></a>
+<span class="sourceLineNo">224</span> return remoteProcedure;<a
name="line.224"></a>
+<span class="sourceLineNo">225</span> }<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> /**<a name="line.228"></a>
+<span class="sourceLineNo">229</span> * Remote procedure reference.<a
name="line.229"></a>
+<span class="sourceLineNo">230</span> */<a name="line.230"></a>
+<span class="sourceLineNo">231</span> public interface
RemoteProcedure<TEnv, TRemote> {<a name="line.231"></a>
+<span class="sourceLineNo">232</span> /**<a name="line.232"></a>
+<span class="sourceLineNo">233</span> * For building the remote
operation.<a name="line.233"></a>
+<span class="sourceLineNo">234</span> */<a name="line.234"></a>
+<span class="sourceLineNo">235</span> RemoteOperation remoteCallBuild(TEnv
env, TRemote remote);<a name="line.235"></a>
+<span class="sourceLineNo">236</span><a name="line.236"></a>
+<span class="sourceLineNo">237</span> /**<a name="line.237"></a>
+<span class="sourceLineNo">238</span> * Called when the executeProcedure
call is failed.<a name="line.238"></a>
+<span class="sourceLineNo">239</span> */<a name="line.239"></a>
+<span class="sourceLineNo">240</span> void remoteCallFailed(TEnv env,
TRemote remote, IOException exception);<a name="line.240"></a>
+<span class="sourceLineNo">241</span><a name="line.241"></a>
+<span class="sourceLineNo">242</span> /**<a name="line.242"></a>
+<span class="sourceLineNo">243</span> * Called when RS tells the remote
procedure is succeeded through the<a name="line.243"></a>
+<span class="sourceLineNo">244</span> * {@code reportProcedureDone}
method.<a name="line.244"></a>
+<span class="sourceLineNo">245</span> */<a name="line.245"></a>
+<span class="sourceLineNo">246</span> void remoteOperationCompleted(TEnv
env);<a name="line.246"></a>
+<span class="sourceLineNo">247</span><a name="line.247"></a>
+<span class="sourceLineNo">248</span> /**<a name="line.248"></a>
+<span class="sourceLineNo">249</span> * Called when RS tells the remote
procedure is failed through the {@code reportProcedureDone}<a
name="line.249"></a>
+<span class="sourceLineNo">250</span> * method.<a name="line.250"></a>
+<span class="sourceLineNo">251</span> */<a name="line.251"></a>
+<span class="sourceLineNo">252</span> void remoteOperationFailed(TEnv env,
RemoteProcedureException error);<a name="line.252"></a>
+<span class="sourceLineNo">253</span> }<a name="line.253"></a>
+<span class="sourceLineNo">254</span><a name="line.254"></a>
+<span class="sourceLineNo">255</span> /**<a name="line.255"></a>
+<span class="sourceLineNo">256</span> * Account of what procedures are
running on remote node.<a name="line.256"></a>
+<span class="sourceLineNo">257</span> * @param <TEnv><a
name="line.257"></a>
+<span class="sourceLineNo">258</span> * @param <TRemote><a
name="line.258"></a>
+<span class="sourceLineNo">259</span> */<a name="line.259"></a>
+<span class="sourceLineNo">260</span> public interface RemoteNode<TEnv,
TRemote> {<a name="line.260"></a>
+<span class="sourceLineNo">261</span> TRemote getKey();<a
name="line.261"></a>
+<span class="sourceLineNo">262</span> void add(RemoteProcedure<TEnv,
TRemote> operation);<a name="line.262"></a>
+<span class="sourceLineNo">263</span> void dispatch();<a
name="line.263"></a>
+<span class="sourceLineNo">264</span> }<a name="line.264"></a>
+<span class="sourceLineNo">265</span><a name="line.265"></a>
+<span class="sourceLineNo">266</span> protected
ArrayListMultimap<Class<?>, RemoteOperation>
buildAndGroupRequestByType(final TEnv env,<a name="line.266"></a>
+<span class="sourceLineNo">267</span> final TRemote remote, final
Set<RemoteProcedure> remoteProcedures) {<a name="line.267"></a>
+<span class="sourceLineNo">268</span> final
ArrayListMultimap<Class<?>, RemoteOperation> requestByType =
ArrayListMultimap.create();<a name="line.268"></a>
+<span class="sourceLineNo">269</span> for (RemoteProcedure proc:
remoteProcedures) {<a name="line.269"></a>
+<span class="sourceLineNo">270</span> RemoteOperation operation =
proc.remoteCallBuild(env, remote);<a name="line.270"></a>
+<span class="sourceLineNo">271</span>
requestByType.put(operation.getClass(), operation);<a name="line.271"></a>
+<span class="sourceLineNo">272</span> }<a name="line.272"></a>
+<span class="sourceLineNo">273</span> return requestByType;<a
name="line.273"></a>
+<span class="sourceLineNo">274</span> }<a name="line.274"></a>
+<span class="sourceLineNo">275</span><a name="line.275"></a>
+<span class="sourceLineNo">276</span> protected <T extends
RemoteOperation> List<T> fetchType(<a name="line.276"></a>
+<span class="sourceLineNo">277</span> final
ArrayListMultimap<Class<?>, RemoteOperation> requestByType, final
Class<T> type) {<a name="line.277"></a>
+<span class="sourceLineNo">278</span> return
(List<T>)requestByType.removeAll(type);<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> //
============================================================================================<a
name="line.281"></a>
+<span class="sourceLineNo">282</span> // Timeout Helpers<a
name="line.282"></a>
+<span class="sourceLineNo">283</span> //
============================================================================================<a
name="line.283"></a>
+<span class="sourceLineNo">284</span> private final class
TimeoutExecutorThread extends Thread {<a name="line.284"></a>
+<span class="sourceLineNo">285</span> private final
DelayQueue<DelayedWithTimeout> queue = new
DelayQueue<DelayedWithTimeout>();<a name="line.285"></a>
+<span class="sourceLineNo">286</span><a name="line.286"></a>
+<span class="sourceLineNo">287</span> public TimeoutExecutorThread() {<a
name="line.287"></a>
+<span class="sourceLineNo">288</span>
super("ProcedureDispatcherTimeoutThread");<a name="line.288"></a>
+<span class="sourceLineNo">289</span> }<a name="line.289"></a>
+<span class="sourceLineNo">290</span><a name="line.290"></a>
+<span class="sourceLineNo">291</span> @Override<a name="line.291"></a>
+<span class="sourceLineNo">292</span> public void run() {<a
name="line.292"></a>
+<span class="sourceLineNo">293</span> while (running.get()) {<a
name="line.293"></a>
+<span class="sourceLineNo">294</span> final DelayedWithTimeout task =
DelayedUtil.takeWithoutInterrupt(queue);<a name="line.294"></a>
+<span class="sourceLineNo">295</span> if (task == null || task ==
DelayedUtil.DELAYED_POISON) {<a name="line.295"></a>
+<span class="sourceLineNo">296</span> // the executor may be shutting
down, and the task is just the shutdown request<a name="line.296"></a>
+<span class="sourceLineNo">297</span> continue;<a name="line.297"></a>
+<span class="sourceLineNo">298</span> }<a name="line.298"></a>
+<span class="sourceLineNo">299</span> if (task instanceof DelayedTask)
{<a name="line.299"></a>
+<span class="sourceLineNo">300</span>
threadPool.execute(((DelayedTask)task).getObject());<a name="line.300"></a>
+<span class="sourceLineNo">301</span> } else {<a name="line.301"></a>
+<span class="sourceLineNo">302</span>
((BufferNode)task).dispatch();<a name="line.302"></a>
+<span class="sourceLineNo">303</span> }<a name="line.303"></a>
+<span class="sourceLineNo">304</span> }<a name="line.304"></a>
+<span class="sourceLineNo">305</span> }<a name="line.305"></a>
+<span class="sourceLineNo">306</span><a name="line.306"></a>
+<span class="sourceLineNo">307</span> public void add(final
DelayedWithTimeout delayed) {<a name="line.307"></a>
+<span class="sourceLineNo">308</span> queue.add(delayed);<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> public void remove(final
DelayedWithTimeout delayed) {<a name="line.311"></a>
+<span class="sourceLineNo">312</span> queue.remove(delayed);<a
name="line.312"></a>
+<span class="sourceLineNo">313</span> }<a name="line.313"></a>
+<span class="sourceLineNo">314</span><a name="line.314"></a>
+<span class="sourceLineNo">315</span> public void sendStopSignal() {<a
name="line.315"></a>
+<span class="sourceLineNo">316</span>
queue.add(DelayedUtil.DELAYED_POISON);<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> public void awaitTermination() {<a
name="line.319"></a>
+<span class="sourceLineNo">320</span> try {<a name="line.320"></a>
+<span class="sourceLineNo">321</span> final long startTime =
EnvironmentEdgeManager.currentTime();<a name="line.321"></a>
+<span class="sourceLineNo">322</span> for (int i = 0; isAlive(); ++i)
{<a name="line.322"></a>
+<span class="sourceLineNo">323</span> sendStopSignal();<a
name="line.323"></a>
+<span class="sourceLineNo">324</span> join(250);<a
name="line.324"></a>
+<span class="sourceLineNo">325</span> if (i > 0 && (i % 8)
== 0) {<a name="line.325"></a>
+<span class="sourceLineNo">326</span> LOG.warn("Waiting termination
of thread " + getName() + ", " +<a name="line.326"></a>
+<span class="sourceLineNo">327</span>
StringUtils.humanTimeDiff(EnvironmentEdgeManager.currentTime() - startTime));<a
name="line.327"></a>
+<span class="sourceLineNo">328</span> }<a name="line.328"></a>
+<span class="sourceLineNo">329</span> }<a name="line.329"></a>
+<span class="sourceLineNo">330</span> } catch (InterruptedException e)
{<a name="line.330"></a>
+<span class="sourceLineNo">331</span> LOG.warn(getName() + " join wait
got interrupted", e);<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> }<a name="line.334"></a>
+<span class="sourceLineNo">335</span><a name="line.335"></a>
+<span class="sourceLineNo">336</span> //
============================================================================================<a
name="line.336"></a>
+<span class="sourceLineNo">337</span> // Internals Helpers<a
name="line.337"></a>
+<span class="sourceLineNo">338</span> //
============================================================================================<a
name="line.338"></a>
+<span class="sourceLineNo">339</span><a name="line.339"></a>
+<span class="sourceLineNo">340</span> /**<a name="line.340"></a>
+<span class="sourceLineNo">341</span> * Node that contains a set of
RemoteProcedures<a name="line.341"></a>
+<span class="sourceLineNo">342</span> */<a name="line.342"></a>
+<span class="sourceLineNo">343</span> protected final class BufferNode
extends DelayedContainerWithTimestamp<TRemote><a name="line.343"></a>
+<span class="sourceLineNo">344</span> implements RemoteNode<TEnv,
TRemote> {<a name="line.344"></a>
+<span class="sourceLineNo">345</span> private Set<RemoteProcedure>
operations;<a name="line.345"></a>
+<span class="sourceLineNo">346</span><a name="line.346"></a>
+<span class="sourceLineNo">347</span> protected BufferNode(final TRemote
key) {<a name="line.347"></a>
+<span class="sourceLineNo">348</span> super(key, 0);<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> @Override<a name="line.351"></a>
+<span class="sourceLineNo">352</span> public TRemote getKey() {<a
name="line.352"></a>
+<span class="sourceLineNo">353</span> return getObject();<a
name="line.353"></a>
+<span class="sourceLineNo">354</span> }<a name="line.354"></a>
+<span class="sourceLineNo">355</span><a name="line.355"></a>
+<span class="sourceLineNo">356</span> @Override<a name="line.356"></a>
+<span class="sourceLineNo">357</span> public synchronized void add(final
RemoteProcedure operation) {<a name="line.357"></a>
+<span class="sourceLineNo">358</span> if (this.operations == null) {<a
name="line.358"></a>
+<span class="sourceLineNo">359</span> this.operations = new
HashSet<>();<a name="line.359"></a>
+<span class="sourceLineNo">360</span>
setTimeout(EnvironmentEdgeManager.currentTime() + operationDelay);<a
name="line.360"></a>
+<span class="sourceLineNo">361</span> timeoutExecutor.add(this);<a
name="line.361"></a>
+<span class="sourceLineNo">362</span> }<a name="line.362"></a>
+<span class="sourceLineNo">363</span> this.operations.add(operation);<a
name="line.363"></a>
+<span class="sourceLineNo">364</span> if (this.operations.size() >
queueMaxSize) {<a name="line.364"></a>
+<span class="sourceLineNo">365</span> timeoutExecutor.remove(this);<a
name="line.365"></a>
+<span class="sourceLineNo">366</span> dispatch();<a name="line.366"></a>
+<span class="sourceLineNo">367</span> }<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> @Override<a name="line.370"></a>
+<span class="sourceLineNo">371</span> public synchronized void dispatch()
{<a name="line.371"></a>
+<span class="sourceLineNo">372</span> if (operations != null) {<a
name="line.372"></a>
+<span class="sourceLineNo">373</span> remoteDispatch(getKey(),
operations);<a name="line.373"></a>
+<span class="sourceLineNo">374</span> this.operations = null;<a
name="line.374"></a>
+<span class="sourceLineNo">375</span> }<a name="line.375"></a>
+<span class="sourceLineNo">376</span> }<a name="line.376"></a>
+<span class="sourceLineNo">377</span><a name="line.377"></a>
+<span class="sourceLineNo">378</span> public synchronized void
abortOperationsInQueue() {<a name="line.378"></a>
+<span class="sourceLineNo">379</span> if (operations != null) {<a
name="line.379"></a>
+<span class="sourceLineNo">380</span> abortPendingOperations(getKey(),
operations);<a name="line.380"></a>
+<span class="sourceLineNo">381</span> this.operations = null;<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><a name="line.384"></a>
+<span class="sourceLineNo">385</span> @Override<a name="line.385"></a>
+<span class="sourceLineNo">386</span> public String toString() {<a
name="line.386"></a>
+<span class="sourceLineNo">387</span> return super.toString() + ",
operations=" + this.operations;<a name="line.387"></a>
+<span class="sourceLineNo">388</span> }<a name="line.388"></a>
+<span class="sourceLineNo">389</span> }<a name="line.389"></a>
+<span class="sourceLineNo">390</span><a name="line.390"></a>
+<span class="sourceLineNo">391</span> /**<a name="line.391"></a>
+<span class="sourceLineNo">392</span> * Delayed object that holds a
FutureTask.<a name="line.392"></a>
+<span class="sourceLineNo">393</span> * used to submit something later to
the thread-pool.<a name="line.393"></a>
+<span class="sourceLineNo">394</span> */<a name="line.394"></a>
+<span class="sourceLineNo">395</span> private static final class DelayedTask
extends DelayedContainerWithTimestamp<FutureTask<Void>> {<a
name="line.395"></a>
+<span class="sourceLineNo">396</span> public DelayedTask(final
FutureTask<Void> task, final long delay, final TimeUnit unit) {<a
name="line.396"></a>
+<span class="sourceLineNo">397</span> super(task,
EnvironmentEdgeManager.currentTime() + unit.toMillis(delay));<a
name="line.397"></a>
+<span class="sourceLineNo">398</span> }<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>