http://git-wip-us.apache.org/repos/asf/hbase-site/blob/425db230/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/store/ProcedureStore.ProcedureIterator.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/store/ProcedureStore.ProcedureIterator.html b/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/store/ProcedureStore.ProcedureIterator.html index e4dc134..2945c58 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/store/ProcedureStore.ProcedureIterator.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/store/ProcedureStore.ProcedureIterator.html @@ -93,157 +93,163 @@ <span class="sourceLineNo">085</span> boolean hasNext();<a name="line.85"></a> <span class="sourceLineNo">086</span><a name="line.86"></a> <span class="sourceLineNo">087</span> /**<a name="line.87"></a> -<span class="sourceLineNo">088</span> * @return true if the iterator next element is a completed procedure.<a name="line.88"></a> -<span class="sourceLineNo">089</span> */<a name="line.89"></a> -<span class="sourceLineNo">090</span> boolean isNextFinished();<a name="line.90"></a> -<span class="sourceLineNo">091</span><a name="line.91"></a> -<span class="sourceLineNo">092</span> /**<a name="line.92"></a> -<span class="sourceLineNo">093</span> * Skip the next procedure<a name="line.93"></a> -<span class="sourceLineNo">094</span> */<a name="line.94"></a> -<span class="sourceLineNo">095</span> void skipNext();<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> * Returns the next procedure in the iteration.<a name="line.98"></a> -<span class="sourceLineNo">099</span> * @throws IOException if there was an error fetching/deserializing the procedure<a name="line.99"></a> -<span class="sourceLineNo">100</span> * @return the next procedure in the iteration.<a name="line.100"></a> -<span class="sourceLineNo">101</span> */<a name="line.101"></a> -<span class="sourceLineNo">102</span> @SuppressWarnings("rawtypes")<a name="line.102"></a> -<span class="sourceLineNo">103</span> Procedure next() throws IOException;<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> /**<a name="line.106"></a> -<span class="sourceLineNo">107</span> * Interface passed to the ProcedureStore.load() method to handle the store-load events.<a name="line.107"></a> -<span class="sourceLineNo">108</span> */<a name="line.108"></a> -<span class="sourceLineNo">109</span> public interface ProcedureLoader {<a name="line.109"></a> -<span class="sourceLineNo">110</span> /**<a name="line.110"></a> -<span class="sourceLineNo">111</span> * Called by ProcedureStore.load() to notify about the maximum proc-id in the store.<a name="line.111"></a> -<span class="sourceLineNo">112</span> * @param maxProcId the highest proc-id in the store<a name="line.112"></a> -<span class="sourceLineNo">113</span> */<a name="line.113"></a> -<span class="sourceLineNo">114</span> void setMaxProcId(long maxProcId);<a name="line.114"></a> -<span class="sourceLineNo">115</span><a name="line.115"></a> +<span class="sourceLineNo">088</span> * Calling this method does not need to converting the protobuf message to the Procedure class,<a name="line.88"></a> +<span class="sourceLineNo">089</span> * so if it returns true we can call {@link #skipNext()} to skip the procedure without<a name="line.89"></a> +<span class="sourceLineNo">090</span> * deserializing. This could increase the performance.<a name="line.90"></a> +<span class="sourceLineNo">091</span> * @return true if the iterator next element is a completed procedure.<a name="line.91"></a> +<span class="sourceLineNo">092</span> */<a name="line.92"></a> +<span class="sourceLineNo">093</span> boolean isNextFinished();<a name="line.93"></a> +<span class="sourceLineNo">094</span><a name="line.94"></a> +<span class="sourceLineNo">095</span> /**<a name="line.95"></a> +<span class="sourceLineNo">096</span> * Skip the next procedure<a name="line.96"></a> +<span class="sourceLineNo">097</span> * <p/><a name="line.97"></a> +<span class="sourceLineNo">098</span> * This method is used to skip the deserializing of the procedure to increase performance, as<a name="line.98"></a> +<span class="sourceLineNo">099</span> * when calling next we need to convert the protobuf message to the Procedure class.<a name="line.99"></a> +<span class="sourceLineNo">100</span> */<a name="line.100"></a> +<span class="sourceLineNo">101</span> void skipNext();<a name="line.101"></a> +<span class="sourceLineNo">102</span><a name="line.102"></a> +<span class="sourceLineNo">103</span> /**<a name="line.103"></a> +<span class="sourceLineNo">104</span> * Returns the next procedure in the iteration.<a name="line.104"></a> +<span class="sourceLineNo">105</span> * @throws IOException if there was an error fetching/deserializing the procedure<a name="line.105"></a> +<span class="sourceLineNo">106</span> * @return the next procedure in the iteration.<a name="line.106"></a> +<span class="sourceLineNo">107</span> */<a name="line.107"></a> +<span class="sourceLineNo">108</span> @SuppressWarnings("rawtypes")<a name="line.108"></a> +<span class="sourceLineNo">109</span> Procedure next() throws IOException;<a name="line.109"></a> +<span class="sourceLineNo">110</span> }<a name="line.110"></a> +<span class="sourceLineNo">111</span><a name="line.111"></a> +<span class="sourceLineNo">112</span> /**<a name="line.112"></a> +<span class="sourceLineNo">113</span> * Interface passed to the ProcedureStore.load() method to handle the store-load events.<a name="line.113"></a> +<span class="sourceLineNo">114</span> */<a name="line.114"></a> +<span class="sourceLineNo">115</span> public interface ProcedureLoader {<a name="line.115"></a> <span class="sourceLineNo">116</span> /**<a name="line.116"></a> -<span class="sourceLineNo">117</span> * Called by the ProcedureStore.load() every time a set of procedures are ready to be executed.<a name="line.117"></a> -<span class="sourceLineNo">118</span> * The ProcedureIterator passed to the method, has the procedure sorted in replay-order.<a name="line.118"></a> -<span class="sourceLineNo">119</span> * @param procIter iterator over the procedures ready to be added to the executor.<a name="line.119"></a> -<span class="sourceLineNo">120</span> */<a name="line.120"></a> -<span class="sourceLineNo">121</span> void load(ProcedureIterator procIter) throws IOException;<a name="line.121"></a> -<span class="sourceLineNo">122</span><a name="line.122"></a> -<span class="sourceLineNo">123</span> /**<a name="line.123"></a> -<span class="sourceLineNo">124</span> * Called by the ProcedureStore.load() in case we have procedures not-ready to be added to<a name="line.124"></a> -<span class="sourceLineNo">125</span> * the executor, which probably means they are corrupted since some information/link is missing.<a name="line.125"></a> -<span class="sourceLineNo">126</span> * @param procIter iterator over the procedures not ready to be added to the executor, corrupted<a name="line.126"></a> -<span class="sourceLineNo">127</span> */<a name="line.127"></a> -<span class="sourceLineNo">128</span> void handleCorrupted(ProcedureIterator procIter) throws IOException;<a name="line.128"></a> -<span class="sourceLineNo">129</span> }<a name="line.129"></a> -<span class="sourceLineNo">130</span><a name="line.130"></a> -<span class="sourceLineNo">131</span> /**<a name="line.131"></a> -<span class="sourceLineNo">132</span> * Add the listener to the notification list.<a name="line.132"></a> -<span class="sourceLineNo">133</span> * @param listener The AssignmentListener to register<a name="line.133"></a> -<span class="sourceLineNo">134</span> */<a name="line.134"></a> -<span class="sourceLineNo">135</span> void registerListener(ProcedureStoreListener listener);<a name="line.135"></a> +<span class="sourceLineNo">117</span> * Called by ProcedureStore.load() to notify about the maximum proc-id in the store.<a name="line.117"></a> +<span class="sourceLineNo">118</span> * @param maxProcId the highest proc-id in the store<a name="line.118"></a> +<span class="sourceLineNo">119</span> */<a name="line.119"></a> +<span class="sourceLineNo">120</span> void setMaxProcId(long maxProcId);<a name="line.120"></a> +<span class="sourceLineNo">121</span><a name="line.121"></a> +<span class="sourceLineNo">122</span> /**<a name="line.122"></a> +<span class="sourceLineNo">123</span> * Called by the ProcedureStore.load() every time a set of procedures are ready to be executed.<a name="line.123"></a> +<span class="sourceLineNo">124</span> * The ProcedureIterator passed to the method, has the procedure sorted in replay-order.<a name="line.124"></a> +<span class="sourceLineNo">125</span> * @param procIter iterator over the procedures ready to be added to the executor.<a name="line.125"></a> +<span class="sourceLineNo">126</span> */<a name="line.126"></a> +<span class="sourceLineNo">127</span> void load(ProcedureIterator procIter) throws IOException;<a name="line.127"></a> +<span class="sourceLineNo">128</span><a name="line.128"></a> +<span class="sourceLineNo">129</span> /**<a name="line.129"></a> +<span class="sourceLineNo">130</span> * Called by the ProcedureStore.load() in case we have procedures not-ready to be added to<a name="line.130"></a> +<span class="sourceLineNo">131</span> * the executor, which probably means they are corrupted since some information/link is missing.<a name="line.131"></a> +<span class="sourceLineNo">132</span> * @param procIter iterator over the procedures not ready to be added to the executor, corrupted<a name="line.132"></a> +<span class="sourceLineNo">133</span> */<a name="line.133"></a> +<span class="sourceLineNo">134</span> void handleCorrupted(ProcedureIterator procIter) throws IOException;<a name="line.134"></a> +<span class="sourceLineNo">135</span> }<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> * Remove the listener from the notification list.<a name="line.138"></a> -<span class="sourceLineNo">139</span> * @param listener The AssignmentListener to unregister<a name="line.139"></a> -<span class="sourceLineNo">140</span> * @return true if the listner was in the list and it was removed, otherwise false.<a name="line.140"></a> -<span class="sourceLineNo">141</span> */<a name="line.141"></a> -<span class="sourceLineNo">142</span> boolean unregisterListener(ProcedureStoreListener listener);<a name="line.142"></a> -<span class="sourceLineNo">143</span><a name="line.143"></a> -<span class="sourceLineNo">144</span> /**<a name="line.144"></a> -<span class="sourceLineNo">145</span> * Start/Open the procedure store<a name="line.145"></a> -<span class="sourceLineNo">146</span> * @param numThreads<a name="line.146"></a> +<span class="sourceLineNo">138</span> * Add the listener to the notification list.<a name="line.138"></a> +<span class="sourceLineNo">139</span> * @param listener The AssignmentListener to register<a name="line.139"></a> +<span class="sourceLineNo">140</span> */<a name="line.140"></a> +<span class="sourceLineNo">141</span> void registerListener(ProcedureStoreListener listener);<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> * Remove the listener from the notification list.<a name="line.144"></a> +<span class="sourceLineNo">145</span> * @param listener The AssignmentListener to unregister<a name="line.145"></a> +<span class="sourceLineNo">146</span> * @return true if the listner was in the list and it was removed, otherwise false.<a name="line.146"></a> <span class="sourceLineNo">147</span> */<a name="line.147"></a> -<span class="sourceLineNo">148</span> void start(int numThreads) throws IOException;<a name="line.148"></a> +<span class="sourceLineNo">148</span> boolean unregisterListener(ProcedureStoreListener listener);<a name="line.148"></a> <span class="sourceLineNo">149</span><a name="line.149"></a> <span class="sourceLineNo">150</span> /**<a name="line.150"></a> -<span class="sourceLineNo">151</span> * Stop/Close the procedure store<a name="line.151"></a> -<span class="sourceLineNo">152</span> * @param abort true if the stop is an abort<a name="line.152"></a> +<span class="sourceLineNo">151</span> * Start/Open the procedure store<a name="line.151"></a> +<span class="sourceLineNo">152</span> * @param numThreads<a name="line.152"></a> <span class="sourceLineNo">153</span> */<a name="line.153"></a> -<span class="sourceLineNo">154</span> void stop(boolean abort);<a name="line.154"></a> +<span class="sourceLineNo">154</span> void start(int numThreads) throws IOException;<a name="line.154"></a> <span class="sourceLineNo">155</span><a name="line.155"></a> <span class="sourceLineNo">156</span> /**<a name="line.156"></a> -<span class="sourceLineNo">157</span> * @return true if the store is running, otherwise false.<a name="line.157"></a> -<span class="sourceLineNo">158</span> */<a name="line.158"></a> -<span class="sourceLineNo">159</span> boolean isRunning();<a name="line.159"></a> -<span class="sourceLineNo">160</span><a name="line.160"></a> -<span class="sourceLineNo">161</span> /**<a name="line.161"></a> -<span class="sourceLineNo">162</span> * @return the number of threads/slots passed to start()<a name="line.162"></a> -<span class="sourceLineNo">163</span> */<a name="line.163"></a> -<span class="sourceLineNo">164</span> int getNumThreads();<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> * Set the number of procedure running.<a name="line.167"></a> -<span class="sourceLineNo">168</span> * This can be used, for example, by the store to know how long to wait before a sync.<a name="line.168"></a> -<span class="sourceLineNo">169</span> * @return how many procedures are running (may not be same as <code>count</code>).<a name="line.169"></a> -<span class="sourceLineNo">170</span> */<a name="line.170"></a> -<span class="sourceLineNo">171</span> int setRunningProcedureCount(int count);<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> * Acquire the lease for the procedure store.<a name="line.174"></a> -<span class="sourceLineNo">175</span> */<a name="line.175"></a> -<span class="sourceLineNo">176</span> void recoverLease() throws IOException;<a name="line.176"></a> -<span class="sourceLineNo">177</span><a name="line.177"></a> -<span class="sourceLineNo">178</span> /**<a name="line.178"></a> -<span class="sourceLineNo">179</span> * Load the Procedures in the store.<a name="line.179"></a> -<span class="sourceLineNo">180</span> * @param loader the ProcedureLoader that will handle the store-load events<a name="line.180"></a> +<span class="sourceLineNo">157</span> * Stop/Close the procedure store<a name="line.157"></a> +<span class="sourceLineNo">158</span> * @param abort true if the stop is an abort<a name="line.158"></a> +<span class="sourceLineNo">159</span> */<a name="line.159"></a> +<span class="sourceLineNo">160</span> void stop(boolean abort);<a name="line.160"></a> +<span class="sourceLineNo">161</span><a name="line.161"></a> +<span class="sourceLineNo">162</span> /**<a name="line.162"></a> +<span class="sourceLineNo">163</span> * @return true if the store is running, otherwise false.<a name="line.163"></a> +<span class="sourceLineNo">164</span> */<a name="line.164"></a> +<span class="sourceLineNo">165</span> boolean isRunning();<a name="line.165"></a> +<span class="sourceLineNo">166</span><a name="line.166"></a> +<span class="sourceLineNo">167</span> /**<a name="line.167"></a> +<span class="sourceLineNo">168</span> * @return the number of threads/slots passed to start()<a name="line.168"></a> +<span class="sourceLineNo">169</span> */<a name="line.169"></a> +<span class="sourceLineNo">170</span> int getNumThreads();<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> * Set the number of procedure running.<a name="line.173"></a> +<span class="sourceLineNo">174</span> * This can be used, for example, by the store to know how long to wait before a sync.<a name="line.174"></a> +<span class="sourceLineNo">175</span> * @return how many procedures are running (may not be same as <code>count</code>).<a name="line.175"></a> +<span class="sourceLineNo">176</span> */<a name="line.176"></a> +<span class="sourceLineNo">177</span> int setRunningProcedureCount(int count);<a name="line.177"></a> +<span class="sourceLineNo">178</span><a name="line.178"></a> +<span class="sourceLineNo">179</span> /**<a name="line.179"></a> +<span class="sourceLineNo">180</span> * Acquire the lease for the procedure store.<a name="line.180"></a> <span class="sourceLineNo">181</span> */<a name="line.181"></a> -<span class="sourceLineNo">182</span> void load(ProcedureLoader loader) throws IOException;<a name="line.182"></a> +<span class="sourceLineNo">182</span> void recoverLease() throws IOException;<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> * When a procedure is submitted to the executor insert(proc, null) will be called.<a name="line.185"></a> -<span class="sourceLineNo">186</span> * 'proc' has a 'RUNNABLE' state and the initial information required to start up.<a name="line.186"></a> -<span class="sourceLineNo">187</span> *<a name="line.187"></a> -<span class="sourceLineNo">188</span> * When a procedure is executed and it returns children insert(proc, subprocs) will be called.<a name="line.188"></a> -<span class="sourceLineNo">189</span> * 'proc' has a 'WAITING' state and an update state.<a name="line.189"></a> -<span class="sourceLineNo">190</span> * 'subprocs' are the children in 'RUNNABLE' state with the initial information.<a name="line.190"></a> -<span class="sourceLineNo">191</span> *<a name="line.191"></a> -<span class="sourceLineNo">192</span> * @param proc the procedure to serialize and write to the store.<a name="line.192"></a> -<span class="sourceLineNo">193</span> * @param subprocs the newly created child of the proc.<a name="line.193"></a> -<span class="sourceLineNo">194</span> */<a name="line.194"></a> -<span class="sourceLineNo">195</span> void insert(Procedure<?> proc, Procedure<?>[] subprocs);<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> * Serialize a set of new procedures.<a name="line.198"></a> -<span class="sourceLineNo">199</span> * These procedures are freshly submitted to the executor and each procedure<a name="line.199"></a> -<span class="sourceLineNo">200</span> * has a 'RUNNABLE' state and the initial information required to start up.<a name="line.200"></a> -<span class="sourceLineNo">201</span> *<a name="line.201"></a> -<span class="sourceLineNo">202</span> * @param procs the procedures to serialize and write to the store.<a name="line.202"></a> -<span class="sourceLineNo">203</span> */<a name="line.203"></a> -<span class="sourceLineNo">204</span> void insert(Procedure<?>[] procs);<a name="line.204"></a> -<span class="sourceLineNo">205</span><a name="line.205"></a> -<span class="sourceLineNo">206</span> /**<a name="line.206"></a> -<span class="sourceLineNo">207</span> * The specified procedure was executed,<a name="line.207"></a> -<span class="sourceLineNo">208</span> * and the new state should be written to the store.<a name="line.208"></a> -<span class="sourceLineNo">209</span> * @param proc the procedure to serialize and write to the store.<a name="line.209"></a> -<span class="sourceLineNo">210</span> */<a name="line.210"></a> -<span class="sourceLineNo">211</span> void update(Procedure<?> proc);<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> * The specified procId was removed from the executor,<a name="line.214"></a> -<span class="sourceLineNo">215</span> * due to completion, abort or failure.<a name="line.215"></a> -<span class="sourceLineNo">216</span> * The store implementor should remove all the information about the specified procId.<a name="line.216"></a> -<span class="sourceLineNo">217</span> * @param procId the ID of the procedure to remove.<a name="line.217"></a> -<span class="sourceLineNo">218</span> */<a name="line.218"></a> -<span class="sourceLineNo">219</span> void delete(long procId);<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> * The parent procedure completed.<a name="line.222"></a> -<span class="sourceLineNo">223</span> * Update the state and mark all the child deleted.<a name="line.223"></a> -<span class="sourceLineNo">224</span> * @param parentProc the parent procedure to serialize and write to the store.<a name="line.224"></a> -<span class="sourceLineNo">225</span> * @param subProcIds the IDs of the sub-procedure to remove.<a name="line.225"></a> -<span class="sourceLineNo">226</span> */<a name="line.226"></a> -<span class="sourceLineNo">227</span> void delete(Procedure<?> parentProc, long[] subProcIds);<a name="line.227"></a> -<span class="sourceLineNo">228</span><a name="line.228"></a> -<span class="sourceLineNo">229</span> /**<a name="line.229"></a> -<span class="sourceLineNo">230</span> * The specified procIds were removed from the executor,<a name="line.230"></a> -<span class="sourceLineNo">231</span> * due to completion, abort or failure.<a name="line.231"></a> -<span class="sourceLineNo">232</span> * The store implementor should remove all the information about the specified procIds.<a name="line.232"></a> -<span class="sourceLineNo">233</span> * @param procIds the IDs of the procedures to remove.<a name="line.233"></a> -<span class="sourceLineNo">234</span> * @param offset the array offset from where to start to delete<a name="line.234"></a> -<span class="sourceLineNo">235</span> * @param count the number of IDs to delete<a name="line.235"></a> -<span class="sourceLineNo">236</span> */<a name="line.236"></a> -<span class="sourceLineNo">237</span> void delete(long[] procIds, int offset, int count);<a name="line.237"></a> -<span class="sourceLineNo">238</span>}<a name="line.238"></a> +<span class="sourceLineNo">185</span> * Load the Procedures in the store.<a name="line.185"></a> +<span class="sourceLineNo">186</span> * @param loader the ProcedureLoader that will handle the store-load events<a name="line.186"></a> +<span class="sourceLineNo">187</span> */<a name="line.187"></a> +<span class="sourceLineNo">188</span> void load(ProcedureLoader loader) throws IOException;<a name="line.188"></a> +<span class="sourceLineNo">189</span><a name="line.189"></a> +<span class="sourceLineNo">190</span> /**<a name="line.190"></a> +<span class="sourceLineNo">191</span> * When a procedure is submitted to the executor insert(proc, null) will be called.<a name="line.191"></a> +<span class="sourceLineNo">192</span> * 'proc' has a 'RUNNABLE' state and the initial information required to start up.<a name="line.192"></a> +<span class="sourceLineNo">193</span> *<a name="line.193"></a> +<span class="sourceLineNo">194</span> * When a procedure is executed and it returns children insert(proc, subprocs) will be called.<a name="line.194"></a> +<span class="sourceLineNo">195</span> * 'proc' has a 'WAITING' state and an update state.<a name="line.195"></a> +<span class="sourceLineNo">196</span> * 'subprocs' are the children in 'RUNNABLE' state with the initial information.<a name="line.196"></a> +<span class="sourceLineNo">197</span> *<a name="line.197"></a> +<span class="sourceLineNo">198</span> * @param proc the procedure to serialize and write to the store.<a name="line.198"></a> +<span class="sourceLineNo">199</span> * @param subprocs the newly created child of the proc.<a name="line.199"></a> +<span class="sourceLineNo">200</span> */<a name="line.200"></a> +<span class="sourceLineNo">201</span> void insert(Procedure<?> proc, Procedure<?>[] subprocs);<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> * Serialize a set of new procedures.<a name="line.204"></a> +<span class="sourceLineNo">205</span> * These procedures are freshly submitted to the executor and each procedure<a name="line.205"></a> +<span class="sourceLineNo">206</span> * has a 'RUNNABLE' state and the initial information required to start up.<a name="line.206"></a> +<span class="sourceLineNo">207</span> *<a name="line.207"></a> +<span class="sourceLineNo">208</span> * @param procs the procedures to serialize and write to the store.<a name="line.208"></a> +<span class="sourceLineNo">209</span> */<a name="line.209"></a> +<span class="sourceLineNo">210</span> void insert(Procedure<?>[] procs);<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> * The specified procedure was executed,<a name="line.213"></a> +<span class="sourceLineNo">214</span> * and the new state should be written to the store.<a name="line.214"></a> +<span class="sourceLineNo">215</span> * @param proc the procedure to serialize and write to the store.<a name="line.215"></a> +<span class="sourceLineNo">216</span> */<a name="line.216"></a> +<span class="sourceLineNo">217</span> void update(Procedure<?> proc);<a name="line.217"></a> +<span class="sourceLineNo">218</span><a name="line.218"></a> +<span class="sourceLineNo">219</span> /**<a name="line.219"></a> +<span class="sourceLineNo">220</span> * The specified procId was removed from the executor,<a name="line.220"></a> +<span class="sourceLineNo">221</span> * due to completion, abort or failure.<a name="line.221"></a> +<span class="sourceLineNo">222</span> * The store implementor should remove all the information about the specified procId.<a name="line.222"></a> +<span class="sourceLineNo">223</span> * @param procId the ID of the procedure to remove.<a name="line.223"></a> +<span class="sourceLineNo">224</span> */<a name="line.224"></a> +<span class="sourceLineNo">225</span> void delete(long procId);<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> * The parent procedure completed.<a name="line.228"></a> +<span class="sourceLineNo">229</span> * Update the state and mark all the child deleted.<a name="line.229"></a> +<span class="sourceLineNo">230</span> * @param parentProc the parent procedure to serialize and write to the store.<a name="line.230"></a> +<span class="sourceLineNo">231</span> * @param subProcIds the IDs of the sub-procedure to remove.<a name="line.231"></a> +<span class="sourceLineNo">232</span> */<a name="line.232"></a> +<span class="sourceLineNo">233</span> void delete(Procedure<?> parentProc, long[] subProcIds);<a name="line.233"></a> +<span class="sourceLineNo">234</span><a name="line.234"></a> +<span class="sourceLineNo">235</span> /**<a name="line.235"></a> +<span class="sourceLineNo">236</span> * The specified procIds were removed from the executor,<a name="line.236"></a> +<span class="sourceLineNo">237</span> * due to completion, abort or failure.<a name="line.237"></a> +<span class="sourceLineNo">238</span> * The store implementor should remove all the information about the specified procIds.<a name="line.238"></a> +<span class="sourceLineNo">239</span> * @param procIds the IDs of the procedures to remove.<a name="line.239"></a> +<span class="sourceLineNo">240</span> * @param offset the array offset from where to start to delete<a name="line.240"></a> +<span class="sourceLineNo">241</span> * @param count the number of IDs to delete<a name="line.241"></a> +<span class="sourceLineNo">242</span> */<a name="line.242"></a> +<span class="sourceLineNo">243</span> void delete(long[] procIds, int offset, int count);<a name="line.243"></a> +<span class="sourceLineNo">244</span>}<a name="line.244"></a>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/425db230/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/store/ProcedureStore.ProcedureLoader.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/store/ProcedureStore.ProcedureLoader.html b/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/store/ProcedureStore.ProcedureLoader.html index e4dc134..2945c58 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/store/ProcedureStore.ProcedureLoader.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/store/ProcedureStore.ProcedureLoader.html @@ -93,157 +93,163 @@ <span class="sourceLineNo">085</span> boolean hasNext();<a name="line.85"></a> <span class="sourceLineNo">086</span><a name="line.86"></a> <span class="sourceLineNo">087</span> /**<a name="line.87"></a> -<span class="sourceLineNo">088</span> * @return true if the iterator next element is a completed procedure.<a name="line.88"></a> -<span class="sourceLineNo">089</span> */<a name="line.89"></a> -<span class="sourceLineNo">090</span> boolean isNextFinished();<a name="line.90"></a> -<span class="sourceLineNo">091</span><a name="line.91"></a> -<span class="sourceLineNo">092</span> /**<a name="line.92"></a> -<span class="sourceLineNo">093</span> * Skip the next procedure<a name="line.93"></a> -<span class="sourceLineNo">094</span> */<a name="line.94"></a> -<span class="sourceLineNo">095</span> void skipNext();<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> * Returns the next procedure in the iteration.<a name="line.98"></a> -<span class="sourceLineNo">099</span> * @throws IOException if there was an error fetching/deserializing the procedure<a name="line.99"></a> -<span class="sourceLineNo">100</span> * @return the next procedure in the iteration.<a name="line.100"></a> -<span class="sourceLineNo">101</span> */<a name="line.101"></a> -<span class="sourceLineNo">102</span> @SuppressWarnings("rawtypes")<a name="line.102"></a> -<span class="sourceLineNo">103</span> Procedure next() throws IOException;<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> /**<a name="line.106"></a> -<span class="sourceLineNo">107</span> * Interface passed to the ProcedureStore.load() method to handle the store-load events.<a name="line.107"></a> -<span class="sourceLineNo">108</span> */<a name="line.108"></a> -<span class="sourceLineNo">109</span> public interface ProcedureLoader {<a name="line.109"></a> -<span class="sourceLineNo">110</span> /**<a name="line.110"></a> -<span class="sourceLineNo">111</span> * Called by ProcedureStore.load() to notify about the maximum proc-id in the store.<a name="line.111"></a> -<span class="sourceLineNo">112</span> * @param maxProcId the highest proc-id in the store<a name="line.112"></a> -<span class="sourceLineNo">113</span> */<a name="line.113"></a> -<span class="sourceLineNo">114</span> void setMaxProcId(long maxProcId);<a name="line.114"></a> -<span class="sourceLineNo">115</span><a name="line.115"></a> +<span class="sourceLineNo">088</span> * Calling this method does not need to converting the protobuf message to the Procedure class,<a name="line.88"></a> +<span class="sourceLineNo">089</span> * so if it returns true we can call {@link #skipNext()} to skip the procedure without<a name="line.89"></a> +<span class="sourceLineNo">090</span> * deserializing. This could increase the performance.<a name="line.90"></a> +<span class="sourceLineNo">091</span> * @return true if the iterator next element is a completed procedure.<a name="line.91"></a> +<span class="sourceLineNo">092</span> */<a name="line.92"></a> +<span class="sourceLineNo">093</span> boolean isNextFinished();<a name="line.93"></a> +<span class="sourceLineNo">094</span><a name="line.94"></a> +<span class="sourceLineNo">095</span> /**<a name="line.95"></a> +<span class="sourceLineNo">096</span> * Skip the next procedure<a name="line.96"></a> +<span class="sourceLineNo">097</span> * <p/><a name="line.97"></a> +<span class="sourceLineNo">098</span> * This method is used to skip the deserializing of the procedure to increase performance, as<a name="line.98"></a> +<span class="sourceLineNo">099</span> * when calling next we need to convert the protobuf message to the Procedure class.<a name="line.99"></a> +<span class="sourceLineNo">100</span> */<a name="line.100"></a> +<span class="sourceLineNo">101</span> void skipNext();<a name="line.101"></a> +<span class="sourceLineNo">102</span><a name="line.102"></a> +<span class="sourceLineNo">103</span> /**<a name="line.103"></a> +<span class="sourceLineNo">104</span> * Returns the next procedure in the iteration.<a name="line.104"></a> +<span class="sourceLineNo">105</span> * @throws IOException if there was an error fetching/deserializing the procedure<a name="line.105"></a> +<span class="sourceLineNo">106</span> * @return the next procedure in the iteration.<a name="line.106"></a> +<span class="sourceLineNo">107</span> */<a name="line.107"></a> +<span class="sourceLineNo">108</span> @SuppressWarnings("rawtypes")<a name="line.108"></a> +<span class="sourceLineNo">109</span> Procedure next() throws IOException;<a name="line.109"></a> +<span class="sourceLineNo">110</span> }<a name="line.110"></a> +<span class="sourceLineNo">111</span><a name="line.111"></a> +<span class="sourceLineNo">112</span> /**<a name="line.112"></a> +<span class="sourceLineNo">113</span> * Interface passed to the ProcedureStore.load() method to handle the store-load events.<a name="line.113"></a> +<span class="sourceLineNo">114</span> */<a name="line.114"></a> +<span class="sourceLineNo">115</span> public interface ProcedureLoader {<a name="line.115"></a> <span class="sourceLineNo">116</span> /**<a name="line.116"></a> -<span class="sourceLineNo">117</span> * Called by the ProcedureStore.load() every time a set of procedures are ready to be executed.<a name="line.117"></a> -<span class="sourceLineNo">118</span> * The ProcedureIterator passed to the method, has the procedure sorted in replay-order.<a name="line.118"></a> -<span class="sourceLineNo">119</span> * @param procIter iterator over the procedures ready to be added to the executor.<a name="line.119"></a> -<span class="sourceLineNo">120</span> */<a name="line.120"></a> -<span class="sourceLineNo">121</span> void load(ProcedureIterator procIter) throws IOException;<a name="line.121"></a> -<span class="sourceLineNo">122</span><a name="line.122"></a> -<span class="sourceLineNo">123</span> /**<a name="line.123"></a> -<span class="sourceLineNo">124</span> * Called by the ProcedureStore.load() in case we have procedures not-ready to be added to<a name="line.124"></a> -<span class="sourceLineNo">125</span> * the executor, which probably means they are corrupted since some information/link is missing.<a name="line.125"></a> -<span class="sourceLineNo">126</span> * @param procIter iterator over the procedures not ready to be added to the executor, corrupted<a name="line.126"></a> -<span class="sourceLineNo">127</span> */<a name="line.127"></a> -<span class="sourceLineNo">128</span> void handleCorrupted(ProcedureIterator procIter) throws IOException;<a name="line.128"></a> -<span class="sourceLineNo">129</span> }<a name="line.129"></a> -<span class="sourceLineNo">130</span><a name="line.130"></a> -<span class="sourceLineNo">131</span> /**<a name="line.131"></a> -<span class="sourceLineNo">132</span> * Add the listener to the notification list.<a name="line.132"></a> -<span class="sourceLineNo">133</span> * @param listener The AssignmentListener to register<a name="line.133"></a> -<span class="sourceLineNo">134</span> */<a name="line.134"></a> -<span class="sourceLineNo">135</span> void registerListener(ProcedureStoreListener listener);<a name="line.135"></a> +<span class="sourceLineNo">117</span> * Called by ProcedureStore.load() to notify about the maximum proc-id in the store.<a name="line.117"></a> +<span class="sourceLineNo">118</span> * @param maxProcId the highest proc-id in the store<a name="line.118"></a> +<span class="sourceLineNo">119</span> */<a name="line.119"></a> +<span class="sourceLineNo">120</span> void setMaxProcId(long maxProcId);<a name="line.120"></a> +<span class="sourceLineNo">121</span><a name="line.121"></a> +<span class="sourceLineNo">122</span> /**<a name="line.122"></a> +<span class="sourceLineNo">123</span> * Called by the ProcedureStore.load() every time a set of procedures are ready to be executed.<a name="line.123"></a> +<span class="sourceLineNo">124</span> * The ProcedureIterator passed to the method, has the procedure sorted in replay-order.<a name="line.124"></a> +<span class="sourceLineNo">125</span> * @param procIter iterator over the procedures ready to be added to the executor.<a name="line.125"></a> +<span class="sourceLineNo">126</span> */<a name="line.126"></a> +<span class="sourceLineNo">127</span> void load(ProcedureIterator procIter) throws IOException;<a name="line.127"></a> +<span class="sourceLineNo">128</span><a name="line.128"></a> +<span class="sourceLineNo">129</span> /**<a name="line.129"></a> +<span class="sourceLineNo">130</span> * Called by the ProcedureStore.load() in case we have procedures not-ready to be added to<a name="line.130"></a> +<span class="sourceLineNo">131</span> * the executor, which probably means they are corrupted since some information/link is missing.<a name="line.131"></a> +<span class="sourceLineNo">132</span> * @param procIter iterator over the procedures not ready to be added to the executor, corrupted<a name="line.132"></a> +<span class="sourceLineNo">133</span> */<a name="line.133"></a> +<span class="sourceLineNo">134</span> void handleCorrupted(ProcedureIterator procIter) throws IOException;<a name="line.134"></a> +<span class="sourceLineNo">135</span> }<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> * Remove the listener from the notification list.<a name="line.138"></a> -<span class="sourceLineNo">139</span> * @param listener The AssignmentListener to unregister<a name="line.139"></a> -<span class="sourceLineNo">140</span> * @return true if the listner was in the list and it was removed, otherwise false.<a name="line.140"></a> -<span class="sourceLineNo">141</span> */<a name="line.141"></a> -<span class="sourceLineNo">142</span> boolean unregisterListener(ProcedureStoreListener listener);<a name="line.142"></a> -<span class="sourceLineNo">143</span><a name="line.143"></a> -<span class="sourceLineNo">144</span> /**<a name="line.144"></a> -<span class="sourceLineNo">145</span> * Start/Open the procedure store<a name="line.145"></a> -<span class="sourceLineNo">146</span> * @param numThreads<a name="line.146"></a> +<span class="sourceLineNo">138</span> * Add the listener to the notification list.<a name="line.138"></a> +<span class="sourceLineNo">139</span> * @param listener The AssignmentListener to register<a name="line.139"></a> +<span class="sourceLineNo">140</span> */<a name="line.140"></a> +<span class="sourceLineNo">141</span> void registerListener(ProcedureStoreListener listener);<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> * Remove the listener from the notification list.<a name="line.144"></a> +<span class="sourceLineNo">145</span> * @param listener The AssignmentListener to unregister<a name="line.145"></a> +<span class="sourceLineNo">146</span> * @return true if the listner was in the list and it was removed, otherwise false.<a name="line.146"></a> <span class="sourceLineNo">147</span> */<a name="line.147"></a> -<span class="sourceLineNo">148</span> void start(int numThreads) throws IOException;<a name="line.148"></a> +<span class="sourceLineNo">148</span> boolean unregisterListener(ProcedureStoreListener listener);<a name="line.148"></a> <span class="sourceLineNo">149</span><a name="line.149"></a> <span class="sourceLineNo">150</span> /**<a name="line.150"></a> -<span class="sourceLineNo">151</span> * Stop/Close the procedure store<a name="line.151"></a> -<span class="sourceLineNo">152</span> * @param abort true if the stop is an abort<a name="line.152"></a> +<span class="sourceLineNo">151</span> * Start/Open the procedure store<a name="line.151"></a> +<span class="sourceLineNo">152</span> * @param numThreads<a name="line.152"></a> <span class="sourceLineNo">153</span> */<a name="line.153"></a> -<span class="sourceLineNo">154</span> void stop(boolean abort);<a name="line.154"></a> +<span class="sourceLineNo">154</span> void start(int numThreads) throws IOException;<a name="line.154"></a> <span class="sourceLineNo">155</span><a name="line.155"></a> <span class="sourceLineNo">156</span> /**<a name="line.156"></a> -<span class="sourceLineNo">157</span> * @return true if the store is running, otherwise false.<a name="line.157"></a> -<span class="sourceLineNo">158</span> */<a name="line.158"></a> -<span class="sourceLineNo">159</span> boolean isRunning();<a name="line.159"></a> -<span class="sourceLineNo">160</span><a name="line.160"></a> -<span class="sourceLineNo">161</span> /**<a name="line.161"></a> -<span class="sourceLineNo">162</span> * @return the number of threads/slots passed to start()<a name="line.162"></a> -<span class="sourceLineNo">163</span> */<a name="line.163"></a> -<span class="sourceLineNo">164</span> int getNumThreads();<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> * Set the number of procedure running.<a name="line.167"></a> -<span class="sourceLineNo">168</span> * This can be used, for example, by the store to know how long to wait before a sync.<a name="line.168"></a> -<span class="sourceLineNo">169</span> * @return how many procedures are running (may not be same as <code>count</code>).<a name="line.169"></a> -<span class="sourceLineNo">170</span> */<a name="line.170"></a> -<span class="sourceLineNo">171</span> int setRunningProcedureCount(int count);<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> * Acquire the lease for the procedure store.<a name="line.174"></a> -<span class="sourceLineNo">175</span> */<a name="line.175"></a> -<span class="sourceLineNo">176</span> void recoverLease() throws IOException;<a name="line.176"></a> -<span class="sourceLineNo">177</span><a name="line.177"></a> -<span class="sourceLineNo">178</span> /**<a name="line.178"></a> -<span class="sourceLineNo">179</span> * Load the Procedures in the store.<a name="line.179"></a> -<span class="sourceLineNo">180</span> * @param loader the ProcedureLoader that will handle the store-load events<a name="line.180"></a> +<span class="sourceLineNo">157</span> * Stop/Close the procedure store<a name="line.157"></a> +<span class="sourceLineNo">158</span> * @param abort true if the stop is an abort<a name="line.158"></a> +<span class="sourceLineNo">159</span> */<a name="line.159"></a> +<span class="sourceLineNo">160</span> void stop(boolean abort);<a name="line.160"></a> +<span class="sourceLineNo">161</span><a name="line.161"></a> +<span class="sourceLineNo">162</span> /**<a name="line.162"></a> +<span class="sourceLineNo">163</span> * @return true if the store is running, otherwise false.<a name="line.163"></a> +<span class="sourceLineNo">164</span> */<a name="line.164"></a> +<span class="sourceLineNo">165</span> boolean isRunning();<a name="line.165"></a> +<span class="sourceLineNo">166</span><a name="line.166"></a> +<span class="sourceLineNo">167</span> /**<a name="line.167"></a> +<span class="sourceLineNo">168</span> * @return the number of threads/slots passed to start()<a name="line.168"></a> +<span class="sourceLineNo">169</span> */<a name="line.169"></a> +<span class="sourceLineNo">170</span> int getNumThreads();<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> * Set the number of procedure running.<a name="line.173"></a> +<span class="sourceLineNo">174</span> * This can be used, for example, by the store to know how long to wait before a sync.<a name="line.174"></a> +<span class="sourceLineNo">175</span> * @return how many procedures are running (may not be same as <code>count</code>).<a name="line.175"></a> +<span class="sourceLineNo">176</span> */<a name="line.176"></a> +<span class="sourceLineNo">177</span> int setRunningProcedureCount(int count);<a name="line.177"></a> +<span class="sourceLineNo">178</span><a name="line.178"></a> +<span class="sourceLineNo">179</span> /**<a name="line.179"></a> +<span class="sourceLineNo">180</span> * Acquire the lease for the procedure store.<a name="line.180"></a> <span class="sourceLineNo">181</span> */<a name="line.181"></a> -<span class="sourceLineNo">182</span> void load(ProcedureLoader loader) throws IOException;<a name="line.182"></a> +<span class="sourceLineNo">182</span> void recoverLease() throws IOException;<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> * When a procedure is submitted to the executor insert(proc, null) will be called.<a name="line.185"></a> -<span class="sourceLineNo">186</span> * 'proc' has a 'RUNNABLE' state and the initial information required to start up.<a name="line.186"></a> -<span class="sourceLineNo">187</span> *<a name="line.187"></a> -<span class="sourceLineNo">188</span> * When a procedure is executed and it returns children insert(proc, subprocs) will be called.<a name="line.188"></a> -<span class="sourceLineNo">189</span> * 'proc' has a 'WAITING' state and an update state.<a name="line.189"></a> -<span class="sourceLineNo">190</span> * 'subprocs' are the children in 'RUNNABLE' state with the initial information.<a name="line.190"></a> -<span class="sourceLineNo">191</span> *<a name="line.191"></a> -<span class="sourceLineNo">192</span> * @param proc the procedure to serialize and write to the store.<a name="line.192"></a> -<span class="sourceLineNo">193</span> * @param subprocs the newly created child of the proc.<a name="line.193"></a> -<span class="sourceLineNo">194</span> */<a name="line.194"></a> -<span class="sourceLineNo">195</span> void insert(Procedure<?> proc, Procedure<?>[] subprocs);<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> * Serialize a set of new procedures.<a name="line.198"></a> -<span class="sourceLineNo">199</span> * These procedures are freshly submitted to the executor and each procedure<a name="line.199"></a> -<span class="sourceLineNo">200</span> * has a 'RUNNABLE' state and the initial information required to start up.<a name="line.200"></a> -<span class="sourceLineNo">201</span> *<a name="line.201"></a> -<span class="sourceLineNo">202</span> * @param procs the procedures to serialize and write to the store.<a name="line.202"></a> -<span class="sourceLineNo">203</span> */<a name="line.203"></a> -<span class="sourceLineNo">204</span> void insert(Procedure<?>[] procs);<a name="line.204"></a> -<span class="sourceLineNo">205</span><a name="line.205"></a> -<span class="sourceLineNo">206</span> /**<a name="line.206"></a> -<span class="sourceLineNo">207</span> * The specified procedure was executed,<a name="line.207"></a> -<span class="sourceLineNo">208</span> * and the new state should be written to the store.<a name="line.208"></a> -<span class="sourceLineNo">209</span> * @param proc the procedure to serialize and write to the store.<a name="line.209"></a> -<span class="sourceLineNo">210</span> */<a name="line.210"></a> -<span class="sourceLineNo">211</span> void update(Procedure<?> proc);<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> * The specified procId was removed from the executor,<a name="line.214"></a> -<span class="sourceLineNo">215</span> * due to completion, abort or failure.<a name="line.215"></a> -<span class="sourceLineNo">216</span> * The store implementor should remove all the information about the specified procId.<a name="line.216"></a> -<span class="sourceLineNo">217</span> * @param procId the ID of the procedure to remove.<a name="line.217"></a> -<span class="sourceLineNo">218</span> */<a name="line.218"></a> -<span class="sourceLineNo">219</span> void delete(long procId);<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> * The parent procedure completed.<a name="line.222"></a> -<span class="sourceLineNo">223</span> * Update the state and mark all the child deleted.<a name="line.223"></a> -<span class="sourceLineNo">224</span> * @param parentProc the parent procedure to serialize and write to the store.<a name="line.224"></a> -<span class="sourceLineNo">225</span> * @param subProcIds the IDs of the sub-procedure to remove.<a name="line.225"></a> -<span class="sourceLineNo">226</span> */<a name="line.226"></a> -<span class="sourceLineNo">227</span> void delete(Procedure<?> parentProc, long[] subProcIds);<a name="line.227"></a> -<span class="sourceLineNo">228</span><a name="line.228"></a> -<span class="sourceLineNo">229</span> /**<a name="line.229"></a> -<span class="sourceLineNo">230</span> * The specified procIds were removed from the executor,<a name="line.230"></a> -<span class="sourceLineNo">231</span> * due to completion, abort or failure.<a name="line.231"></a> -<span class="sourceLineNo">232</span> * The store implementor should remove all the information about the specified procIds.<a name="line.232"></a> -<span class="sourceLineNo">233</span> * @param procIds the IDs of the procedures to remove.<a name="line.233"></a> -<span class="sourceLineNo">234</span> * @param offset the array offset from where to start to delete<a name="line.234"></a> -<span class="sourceLineNo">235</span> * @param count the number of IDs to delete<a name="line.235"></a> -<span class="sourceLineNo">236</span> */<a name="line.236"></a> -<span class="sourceLineNo">237</span> void delete(long[] procIds, int offset, int count);<a name="line.237"></a> -<span class="sourceLineNo">238</span>}<a name="line.238"></a> +<span class="sourceLineNo">185</span> * Load the Procedures in the store.<a name="line.185"></a> +<span class="sourceLineNo">186</span> * @param loader the ProcedureLoader that will handle the store-load events<a name="line.186"></a> +<span class="sourceLineNo">187</span> */<a name="line.187"></a> +<span class="sourceLineNo">188</span> void load(ProcedureLoader loader) throws IOException;<a name="line.188"></a> +<span class="sourceLineNo">189</span><a name="line.189"></a> +<span class="sourceLineNo">190</span> /**<a name="line.190"></a> +<span class="sourceLineNo">191</span> * When a procedure is submitted to the executor insert(proc, null) will be called.<a name="line.191"></a> +<span class="sourceLineNo">192</span> * 'proc' has a 'RUNNABLE' state and the initial information required to start up.<a name="line.192"></a> +<span class="sourceLineNo">193</span> *<a name="line.193"></a> +<span class="sourceLineNo">194</span> * When a procedure is executed and it returns children insert(proc, subprocs) will be called.<a name="line.194"></a> +<span class="sourceLineNo">195</span> * 'proc' has a 'WAITING' state and an update state.<a name="line.195"></a> +<span class="sourceLineNo">196</span> * 'subprocs' are the children in 'RUNNABLE' state with the initial information.<a name="line.196"></a> +<span class="sourceLineNo">197</span> *<a name="line.197"></a> +<span class="sourceLineNo">198</span> * @param proc the procedure to serialize and write to the store.<a name="line.198"></a> +<span class="sourceLineNo">199</span> * @param subprocs the newly created child of the proc.<a name="line.199"></a> +<span class="sourceLineNo">200</span> */<a name="line.200"></a> +<span class="sourceLineNo">201</span> void insert(Procedure<?> proc, Procedure<?>[] subprocs);<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> * Serialize a set of new procedures.<a name="line.204"></a> +<span class="sourceLineNo">205</span> * These procedures are freshly submitted to the executor and each procedure<a name="line.205"></a> +<span class="sourceLineNo">206</span> * has a 'RUNNABLE' state and the initial information required to start up.<a name="line.206"></a> +<span class="sourceLineNo">207</span> *<a name="line.207"></a> +<span class="sourceLineNo">208</span> * @param procs the procedures to serialize and write to the store.<a name="line.208"></a> +<span class="sourceLineNo">209</span> */<a name="line.209"></a> +<span class="sourceLineNo">210</span> void insert(Procedure<?>[] procs);<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> * The specified procedure was executed,<a name="line.213"></a> +<span class="sourceLineNo">214</span> * and the new state should be written to the store.<a name="line.214"></a> +<span class="sourceLineNo">215</span> * @param proc the procedure to serialize and write to the store.<a name="line.215"></a> +<span class="sourceLineNo">216</span> */<a name="line.216"></a> +<span class="sourceLineNo">217</span> void update(Procedure<?> proc);<a name="line.217"></a> +<span class="sourceLineNo">218</span><a name="line.218"></a> +<span class="sourceLineNo">219</span> /**<a name="line.219"></a> +<span class="sourceLineNo">220</span> * The specified procId was removed from the executor,<a name="line.220"></a> +<span class="sourceLineNo">221</span> * due to completion, abort or failure.<a name="line.221"></a> +<span class="sourceLineNo">222</span> * The store implementor should remove all the information about the specified procId.<a name="line.222"></a> +<span class="sourceLineNo">223</span> * @param procId the ID of the procedure to remove.<a name="line.223"></a> +<span class="sourceLineNo">224</span> */<a name="line.224"></a> +<span class="sourceLineNo">225</span> void delete(long procId);<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> * The parent procedure completed.<a name="line.228"></a> +<span class="sourceLineNo">229</span> * Update the state and mark all the child deleted.<a name="line.229"></a> +<span class="sourceLineNo">230</span> * @param parentProc the parent procedure to serialize and write to the store.<a name="line.230"></a> +<span class="sourceLineNo">231</span> * @param subProcIds the IDs of the sub-procedure to remove.<a name="line.231"></a> +<span class="sourceLineNo">232</span> */<a name="line.232"></a> +<span class="sourceLineNo">233</span> void delete(Procedure<?> parentProc, long[] subProcIds);<a name="line.233"></a> +<span class="sourceLineNo">234</span><a name="line.234"></a> +<span class="sourceLineNo">235</span> /**<a name="line.235"></a> +<span class="sourceLineNo">236</span> * The specified procIds were removed from the executor,<a name="line.236"></a> +<span class="sourceLineNo">237</span> * due to completion, abort or failure.<a name="line.237"></a> +<span class="sourceLineNo">238</span> * The store implementor should remove all the information about the specified procIds.<a name="line.238"></a> +<span class="sourceLineNo">239</span> * @param procIds the IDs of the procedures to remove.<a name="line.239"></a> +<span class="sourceLineNo">240</span> * @param offset the array offset from where to start to delete<a name="line.240"></a> +<span class="sourceLineNo">241</span> * @param count the number of IDs to delete<a name="line.241"></a> +<span class="sourceLineNo">242</span> */<a name="line.242"></a> +<span class="sourceLineNo">243</span> void delete(long[] procIds, int offset, int count);<a name="line.243"></a> +<span class="sourceLineNo">244</span>}<a name="line.244"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/425db230/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/store/ProcedureStore.ProcedureStoreListener.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/store/ProcedureStore.ProcedureStoreListener.html b/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/store/ProcedureStore.ProcedureStoreListener.html index e4dc134..2945c58 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/store/ProcedureStore.ProcedureStoreListener.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/store/ProcedureStore.ProcedureStoreListener.html @@ -93,157 +93,163 @@ <span class="sourceLineNo">085</span> boolean hasNext();<a name="line.85"></a> <span class="sourceLineNo">086</span><a name="line.86"></a> <span class="sourceLineNo">087</span> /**<a name="line.87"></a> -<span class="sourceLineNo">088</span> * @return true if the iterator next element is a completed procedure.<a name="line.88"></a> -<span class="sourceLineNo">089</span> */<a name="line.89"></a> -<span class="sourceLineNo">090</span> boolean isNextFinished();<a name="line.90"></a> -<span class="sourceLineNo">091</span><a name="line.91"></a> -<span class="sourceLineNo">092</span> /**<a name="line.92"></a> -<span class="sourceLineNo">093</span> * Skip the next procedure<a name="line.93"></a> -<span class="sourceLineNo">094</span> */<a name="line.94"></a> -<span class="sourceLineNo">095</span> void skipNext();<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> * Returns the next procedure in the iteration.<a name="line.98"></a> -<span class="sourceLineNo">099</span> * @throws IOException if there was an error fetching/deserializing the procedure<a name="line.99"></a> -<span class="sourceLineNo">100</span> * @return the next procedure in the iteration.<a name="line.100"></a> -<span class="sourceLineNo">101</span> */<a name="line.101"></a> -<span class="sourceLineNo">102</span> @SuppressWarnings("rawtypes")<a name="line.102"></a> -<span class="sourceLineNo">103</span> Procedure next() throws IOException;<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> /**<a name="line.106"></a> -<span class="sourceLineNo">107</span> * Interface passed to the ProcedureStore.load() method to handle the store-load events.<a name="line.107"></a> -<span class="sourceLineNo">108</span> */<a name="line.108"></a> -<span class="sourceLineNo">109</span> public interface ProcedureLoader {<a name="line.109"></a> -<span class="sourceLineNo">110</span> /**<a name="line.110"></a> -<span class="sourceLineNo">111</span> * Called by ProcedureStore.load() to notify about the maximum proc-id in the store.<a name="line.111"></a> -<span class="sourceLineNo">112</span> * @param maxProcId the highest proc-id in the store<a name="line.112"></a> -<span class="sourceLineNo">113</span> */<a name="line.113"></a> -<span class="sourceLineNo">114</span> void setMaxProcId(long maxProcId);<a name="line.114"></a> -<span class="sourceLineNo">115</span><a name="line.115"></a> +<span class="sourceLineNo">088</span> * Calling this method does not need to converting the protobuf message to the Procedure class,<a name="line.88"></a> +<span class="sourceLineNo">089</span> * so if it returns true we can call {@link #skipNext()} to skip the procedure without<a name="line.89"></a> +<span class="sourceLineNo">090</span> * deserializing. This could increase the performance.<a name="line.90"></a> +<span class="sourceLineNo">091</span> * @return true if the iterator next element is a completed procedure.<a name="line.91"></a> +<span class="sourceLineNo">092</span> */<a name="line.92"></a> +<span class="sourceLineNo">093</span> boolean isNextFinished();<a name="line.93"></a> +<span class="sourceLineNo">094</span><a name="line.94"></a> +<span class="sourceLineNo">095</span> /**<a name="line.95"></a> +<span class="sourceLineNo">096</span> * Skip the next procedure<a name="line.96"></a> +<span class="sourceLineNo">097</span> * <p/><a name="line.97"></a> +<span class="sourceLineNo">098</span> * This method is used to skip the deserializing of the procedure to increase performance, as<a name="line.98"></a> +<span class="sourceLineNo">099</span> * when calling next we need to convert the protobuf message to the Procedure class.<a name="line.99"></a> +<span class="sourceLineNo">100</span> */<a name="line.100"></a> +<span class="sourceLineNo">101</span> void skipNext();<a name="line.101"></a> +<span class="sourceLineNo">102</span><a name="line.102"></a> +<span class="sourceLineNo">103</span> /**<a name="line.103"></a> +<span class="sourceLineNo">104</span> * Returns the next procedure in the iteration.<a name="line.104"></a> +<span class="sourceLineNo">105</span> * @throws IOException if there was an error fetching/deserializing the procedure<a name="line.105"></a> +<span class="sourceLineNo">106</span> * @return the next procedure in the iteration.<a name="line.106"></a> +<span class="sourceLineNo">107</span> */<a name="line.107"></a> +<span class="sourceLineNo">108</span> @SuppressWarnings("rawtypes")<a name="line.108"></a> +<span class="sourceLineNo">109</span> Procedure next() throws IOException;<a name="line.109"></a> +<span class="sourceLineNo">110</span> }<a name="line.110"></a> +<span class="sourceLineNo">111</span><a name="line.111"></a> +<span class="sourceLineNo">112</span> /**<a name="line.112"></a> +<span class="sourceLineNo">113</span> * Interface passed to the ProcedureStore.load() method to handle the store-load events.<a name="line.113"></a> +<span class="sourceLineNo">114</span> */<a name="line.114"></a> +<span class="sourceLineNo">115</span> public interface ProcedureLoader {<a name="line.115"></a> <span class="sourceLineNo">116</span> /**<a name="line.116"></a> -<span class="sourceLineNo">117</span> * Called by the ProcedureStore.load() every time a set of procedures are ready to be executed.<a name="line.117"></a> -<span class="sourceLineNo">118</span> * The ProcedureIterator passed to the method, has the procedure sorted in replay-order.<a name="line.118"></a> -<span class="sourceLineNo">119</span> * @param procIter iterator over the procedures ready to be added to the executor.<a name="line.119"></a> -<span class="sourceLineNo">120</span> */<a name="line.120"></a> -<span class="sourceLineNo">121</span> void load(ProcedureIterator procIter) throws IOException;<a name="line.121"></a> -<span class="sourceLineNo">122</span><a name="line.122"></a> -<span class="sourceLineNo">123</span> /**<a name="line.123"></a> -<span class="sourceLineNo">124</span> * Called by the ProcedureStore.load() in case we have procedures not-ready to be added to<a name="line.124"></a> -<span class="sourceLineNo">125</span> * the executor, which probably means they are corrupted since some information/link is missing.<a name="line.125"></a> -<span class="sourceLineNo">126</span> * @param procIter iterator over the procedures not ready to be added to the executor, corrupted<a name="line.126"></a> -<span class="sourceLineNo">127</span> */<a name="line.127"></a> -<span class="sourceLineNo">128</span> void handleCorrupted(ProcedureIterator procIter) throws IOException;<a name="line.128"></a> -<span class="sourceLineNo">129</span> }<a name="line.129"></a> -<span class="sourceLineNo">130</span><a name="line.130"></a> -<span class="sourceLineNo">131</span> /**<a name="line.131"></a> -<span class="sourceLineNo">132</span> * Add the listener to the notification list.<a name="line.132"></a> -<span class="sourceLineNo">133</span> * @param listener The AssignmentListener to register<a name="line.133"></a> -<span class="sourceLineNo">134</span> */<a name="line.134"></a> -<span class="sourceLineNo">135</span> void registerListener(ProcedureStoreListener listener);<a name="line.135"></a> +<span class="sourceLineNo">117</span> * Called by ProcedureStore.load() to notify about the maximum proc-id in the store.<a name="line.117"></a> +<span class="sourceLineNo">118</span> * @param maxProcId the highest proc-id in the store<a name="line.118"></a> +<span class="sourceLineNo">119</span> */<a name="line.119"></a> +<span class="sourceLineNo">120</span> void setMaxProcId(long maxProcId);<a name="line.120"></a> +<span class="sourceLineNo">121</span><a name="line.121"></a> +<span class="sourceLineNo">122</span> /**<a name="line.122"></a> +<span class="sourceLineNo">123</span> * Called by the ProcedureStore.load() every time a set of procedures are ready to be executed.<a name="line.123"></a> +<span class="sourceLineNo">124</span> * The ProcedureIterator passed to the method, has the procedure sorted in replay-order.<a name="line.124"></a> +<span class="sourceLineNo">125</span> * @param procIter iterator over the procedures ready to be added to the executor.<a name="line.125"></a> +<span class="sourceLineNo">126</span> */<a name="line.126"></a> +<span class="sourceLineNo">127</span> void load(ProcedureIterator procIter) throws IOException;<a name="line.127"></a> +<span class="sourceLineNo">128</span><a name="line.128"></a> +<span class="sourceLineNo">129</span> /**<a name="line.129"></a> +<span class="sourceLineNo">130</span> * Called by the ProcedureStore.load() in case we have procedures not-ready to be added to<a name="line.130"></a> +<span class="sourceLineNo">131</span> * the executor, which probably means they are corrupted since some information/link is missing.<a name="line.131"></a> +<span class="sourceLineNo">132</span> * @param procIter iterator over the procedures not ready to be added to the executor, corrupted<a name="line.132"></a> +<span class="sourceLineNo">133</span> */<a name="line.133"></a> +<span class="sourceLineNo">134</span> void handleCorrupted(ProcedureIterator procIter) throws IOException;<a name="line.134"></a> +<span class="sourceLineNo">135</span> }<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> * Remove the listener from the notification list.<a name="line.138"></a> -<span class="sourceLineNo">139</span> * @param listener The AssignmentListener to unregister<a name="line.139"></a> -<span class="sourceLineNo">140</span> * @return true if the listner was in the list and it was removed, otherwise false.<a name="line.140"></a> -<span class="sourceLineNo">141</span> */<a name="line.141"></a> -<span class="sourceLineNo">142</span> boolean unregisterListener(ProcedureStoreListener listener);<a name="line.142"></a> -<span class="sourceLineNo">143</span><a name="line.143"></a> -<span class="sourceLineNo">144</span> /**<a name="line.144"></a> -<span class="sourceLineNo">145</span> * Start/Open the procedure store<a name="line.145"></a> -<span class="sourceLineNo">146</span> * @param numThreads<a name="line.146"></a> +<span class="sourceLineNo">138</span> * Add the listener to the notification list.<a name="line.138"></a> +<span class="sourceLineNo">139</span> * @param listener The AssignmentListener to register<a name="line.139"></a> +<span class="sourceLineNo">140</span> */<a name="line.140"></a> +<span class="sourceLineNo">141</span> void registerListener(ProcedureStoreListener listener);<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> * Remove the listener from the notification list.<a name="line.144"></a> +<span class="sourceLineNo">145</span> * @param listener The AssignmentListener to unregister<a name="line.145"></a> +<span class="sourceLineNo">146</span> * @return true if the listner was in the list and it was removed, otherwise false.<a name="line.146"></a> <span class="sourceLineNo">147</span> */<a name="line.147"></a> -<span class="sourceLineNo">148</span> void start(int numThreads) throws IOException;<a name="line.148"></a> +<span class="sourceLineNo">148</span> boolean unregisterListener(ProcedureStoreListener listener);<a name="line.148"></a> <span class="sourceLineNo">149</span><a name="line.149"></a> <span class="sourceLineNo">150</span> /**<a name="line.150"></a> -<span class="sourceLineNo">151</span> * Stop/Close the procedure store<a name="line.151"></a> -<span class="sourceLineNo">152</span> * @param abort true if the stop is an abort<a name="line.152"></a> +<span class="sourceLineNo">151</span> * Start/Open the procedure store<a name="line.151"></a> +<span class="sourceLineNo">152</span> * @param numThreads<a name="line.152"></a> <span class="sourceLineNo">153</span> */<a name="line.153"></a> -<span class="sourceLineNo">154</span> void stop(boolean abort);<a name="line.154"></a> +<span class="sourceLineNo">154</span> void start(int numThreads) throws IOException;<a name="line.154"></a> <span class="sourceLineNo">155</span><a name="line.155"></a> <span class="sourceLineNo">156</span> /**<a name="line.156"></a> -<span class="sourceLineNo">157</span> * @return true if the store is running, otherwise false.<a name="line.157"></a> -<span class="sourceLineNo">158</span> */<a name="line.158"></a> -<span class="sourceLineNo">159</span> boolean isRunning();<a name="line.159"></a> -<span class="sourceLineNo">160</span><a name="line.160"></a> -<span class="sourceLineNo">161</span> /**<a name="line.161"></a> -<span class="sourceLineNo">162</span> * @return the number of threads/slots passed to start()<a name="line.162"></a> -<span class="sourceLineNo">163</span> */<a name="line.163"></a> -<span class="sourceLineNo">164</span> int getNumThreads();<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> * Set the number of procedure running.<a name="line.167"></a> -<span class="sourceLineNo">168</span> * This can be used, for example, by the store to know how long to wait before a sync.<a name="line.168"></a> -<span class="sourceLineNo">169</span> * @return how many procedures are running (may not be same as <code>count</code>).<a name="line.169"></a> -<span class="sourceLineNo">170</span> */<a name="line.170"></a> -<span class="sourceLineNo">171</span> int setRunningProcedureCount(int count);<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> * Acquire the lease for the procedure store.<a name="line.174"></a> -<span class="sourceLineNo">175</span> */<a name="line.175"></a> -<span class="sourceLineNo">176</span> void recoverLease() throws IOException;<a name="line.176"></a> -<span class="sourceLineNo">177</span><a name="line.177"></a> -<span class="sourceLineNo">178</span> /**<a name="line.178"></a> -<span class="sourceLineNo">179</span> * Load the Procedures in the store.<a name="line.179"></a> -<span class="sourceLineNo">180</span> * @param loader the ProcedureLoader that will handle the store-load events<a name="line.180"></a> +<span class="sourceLineNo">157</span> * Stop/Close the procedure store<a name="line.157"></a> +<span class="sourceLineNo">158</span> * @param abort true if the stop is an abort<a name="line.158"></a> +<span class="sourceLineNo">159</span> */<a name="line.159"></a> +<span class="sourceLineNo">160</span> void stop(boolean abort);<a name="line.160"></a> +<span class="sourceLineNo">161</span><a name="line.161"></a> +<span class="sourceLineNo">162</span> /**<a name="line.162"></a> +<span class="sourceLineNo">163</span> * @return true if the store is running, otherwise false.<a name="line.163"></a> +<span class="sourceLineNo">164</span> */<a name="line.164"></a> +<span class="sourceLineNo">165</span> boolean isRunning();<a name="line.165"></a> +<span class="sourceLineNo">166</span><a name="line.166"></a> +<span class="sourceLineNo">167</span> /**<a name="line.167"></a> +<span class="sourceLineNo">168</span> * @return the number of threads/slots passed to start()<a name="line.168"></a> +<span class="sourceLineNo">169</span> */<a name="line.169"></a> +<span class="sourceLineNo">170</span> int getNumThreads();<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> * Set the number of procedure running.<a name="line.173"></a> +<span class="sourceLineNo">174</span> * This can be used, for example, by the store to know how long to wait before a sync.<a name="line.174"></a> +<span class="sourceLineNo">175</span> * @return how many procedures are running (may not be same as <code>count</code>).<a name="line.175"></a> +<span class="sourceLineNo">176</span> */<a name="line.176"></a> +<span class="sourceLineNo">177</span> int setRunningProcedureCount(int count);<a name="line.177"></a> +<span class="sourceLineNo">178</span><a name="line.178"></a> +<span class="sourceLineNo">179</span> /**<a name="line.179"></a> +<span class="sourceLineNo">180</span> * Acquire the lease for the procedure store.<a name="line.180"></a> <span class="sourceLineNo">181</span> */<a name="line.181"></a> -<span class="sourceLineNo">182</span> void load(ProcedureLoader loader) throws IOException;<a name="line.182"></a> +<span class="sourceLineNo">182</span> void recoverLease() throws IOException;<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> * When a procedure is submitted to the executor insert(proc, null) will be called.<a name="line.185"></a> -<span class="sourceLineNo">186</span> * 'proc' has a 'RUNNABLE' state and the initial information required to start up.<a name="line.186"></a> -<span class="sourceLineNo">187</span> *<a name="line.187"></a> -<span class="sourceLineNo">188</span> * When a procedure is executed and it returns children insert(proc, subprocs) will be called.<a name="line.188"></a> -<span class="sourceLineNo">189</span> * 'proc' has a 'WAITING' state and an update state.<a name="line.189"></a> -<span class="sourceLineNo">190</span> * 'subprocs' are the children in 'RUNNABLE' state with the initial information.<a name="line.190"></a> -<span class="sourceLineNo">191</span> *<a name="line.191"></a> -<span class="sourceLineNo">192</span> * @param proc the procedure to serialize and write to the store.<a name="line.192"></a> -<span class="sourceLineNo">193</span> * @param subprocs the newly created child of the proc.<a name="line.193"></a> -<span class="sourceLineNo">194</span> */<a name="line.194"></a> -<span class="sourceLineNo">195</span> void insert(Procedure<?> proc, Procedure<?>[] subprocs);<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> * Serialize a set of new procedures.<a name="line.198"></a> -<span class="sourceLineNo">199</span> * These procedures are freshly submitted to the executor and each procedure<a name="line.199"></a> -<span class="sourceLineNo">200</span> * has a 'RUNNABLE' state and the initial information required to start up.<a name="line.200"></a> -<span class="sourceLineNo">201</span> *<a name="line.201"></a> -<span class="sourceLineNo">202</span> * @param procs the procedures to serialize and write to the store.<a name="line.202"></a> -<span class="sourceLineNo">203</span> */<a name="line.203"></a> -<span class="sourceLineNo">204</span> void insert(Procedure<?>[] procs);<a name="line.204"></a> -<span class="sourceLineNo">205</span><a name="line.205"></a> -<span class="sourceLineNo">206</span> /**<a name="line.206"></a> -<span class="sourceLineNo">207</span> * The specified procedure was executed,<a name="line.207"></a> -<span class="sourceLineNo">208</span> * and the new state should be written to the store.<a name="line.208"></a> -<span class="sourceLineNo">209</span> * @param proc the procedure to serialize and write to the store.<a name="line.209"></a> -<span class="sourceLineNo">210</span> */<a name="line.210"></a> -<span class="sourceLineNo">211</span> void update(Procedure<?> proc);<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> * The specified procId was removed from the executor,<a name="line.214"></a> -<span class="sourceLineNo">215</span> * due to completion, abort or failure.<a name="line.215"></a> -<span class="sourceLineNo">216</span> * The store implementor should remove all the information about the specified procId.<a name="line.216"></a> -<span class="sourceLineNo">217</span> * @param procId the ID of the procedure to remove.<a name="line.217"></a> -<span class="sourceLineNo">218</span> */<a name="line.218"></a> -<span class="sourceLineNo">219</span> void delete(long procId);<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> * The parent procedure completed.<a name="line.222"></a> -<span class="sourceLineNo">223</span> * Update the state and mark all the child deleted.<a name="line.223"></a> -<span class="sourceLineNo">224</span> * @param parentProc the parent procedure to serialize and write to the store.<a name="line.224"></a> -<span class="sourceLineNo">225</span> * @param subProcIds the IDs of the sub-procedure to remove.<a name="line.225"></a> -<span class="sourceLineNo">226</span> */<a name="line.226"></a> -<span class="sourceLineNo">227</span> void delete(Procedure<?> parentProc, long[] subProcIds);<a name="line.227"></a> -<span class="sourceLineNo">228</span><a name="line.228"></a> -<span class="sourceLineNo">229</span> /**<a name="line.229"></a> -<span class="sourceLineNo">230</span> * The specified procIds were removed from the executor,<a name="line.230"></a> -<span class="sourceLineNo">231</span> * due to completion, abort or failure.<a name="line.231"></a> -<span class="sourceLineNo">232</span> * The store implementor should remove all the information about the specified procIds.<a name="line.232"></a> -<span class="sourceLineNo">233</span> * @param procIds the IDs of the procedures to remove.<a name="line.233"></a> -<span class="sourceLineNo">234</span> * @param offset the array offset from where to start to delete<a name="line.234"></a> -<span class="sourceLineNo">235</span> * @param count the number of IDs to delete<a name="line.235"></a> -<span class="sourceLineNo">236</span> */<a name="line.236"></a> -<span class="sourceLineNo">237</span> void delete(long[] procIds, int offset, int count);<a name="line.237"></a> -<span class="sourceLineNo">238</span>}<a name="line.238"></a> +<span class="sourceLineNo">185</span> * Load the Procedures in the store.<a name="line.185"></a> +<span class="sourceLineNo">186</span> * @param loader the ProcedureLoader that will handle the store-load events<a name="line.186"></a> +<span class="sourceLineNo">187</span> */<a name="line.187"></a> +<span class="sourceLineNo">188</span> void load(ProcedureLoader loader) throws IOException;<a name="line.188"></a> +<span class="sourceLineNo">189</span><a name="line.189"></a> +<span class="sourceLineNo">190</span> /**<a name="line.190"></a> +<span class="sourceLineNo">191</span> * When a procedure is submitted to the executor insert(proc, null) will be called.<a name="line.191"></a> +<span class="sourceLineNo">192</span> * 'proc' has a 'RUNNABLE' state and the initial information required to start up.<a name="line.192"></a> +<span class="sourceLineNo">193</span> *<a name="line.193"></a> +<span class="sourceLineNo">194</span> * When a procedure is executed and it returns children insert(proc, subprocs) will be called.<a name="line.194"></a> +<span class="sourceLineNo">195</span> * 'proc' has a 'WAITING' state and an update state.<a name="line.195"></a> +<span class="sourceLineNo">196</span> * 'subprocs' are the children in 'RUNNABLE' state with the initial information.<a name="line.196"></a> +<span class="sourceLineNo">197</span> *<a name="line.197"></a> +<span class="sourceLineNo">198</span> * @param proc the procedure to serialize and write to the store.<a name="line.198"></a> +<span class="sourceLineNo">199</span> * @param subprocs the newly created child of the proc.<a name="line.199"></a> +<span class="sourceLineNo">200</span> */<a name="line.200"></a> +<span class="sourceLineNo">201</span> void insert(Procedure<?> proc, Procedure<?>[] subprocs);<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> * Serialize a set of new procedures.<a name="line.204"></a> +<span class="sourceLineNo">205</span> * These procedures are freshly submitted to the executor and each procedure<a name="line.205"></a> +<span class="sourceLineNo">206</span> * has a 'RUNNABLE' state and the initial information required to start up.<a name="line.206"></a> +<span class="sourceLineNo">207</span> *<a name="line.207"></a> +<span class="sourceLineNo">208</span> * @param procs the procedures to serialize and write to the store.<a name="line.208"></a> +<span class="sourceLineNo">209</span> */<a name="line.209"></a> +<span class="sourceLineNo">210</span> void insert(Procedure<?>[] procs);<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> * The specified procedure was executed,<a name="line.213"></a> +<span class="sourceLineNo">214</span> * and the new state should be written to the store.<a name="line.214"></a> +<span class="sourceLineNo">215</span> * @param proc the procedure to serialize and write to the store.<a name="line.215"></a> +<span class="sourceLineNo">216</span> */<a name="line.216"></a> +<span class="sourceLineNo">217</span> void update(Procedure<?> proc);<a name="line.217"></a> +<span class="sourceLineNo">218</span><a name="line.218"></a> +<span class="sourceLineNo">219</span> /**<a name="line.219"></a> +<span class="sourceLineNo">220</span> * The specified procId was removed from the executor,<a name="line.220"></a> +<span class="sourceLineNo">221</span> * due to completion, abort or failure.<a name="line.221"></a> +<span class="sourceLineNo">222</span> * The store implementor should remove all the information about the specified procId.<a name="line.222"></a> +<span class="sourceLineNo">223</span> * @param procId the ID of the procedure to remove.<a name="line.223"></a> +<span class="sourceLineNo">224</span> */<a name="line.224"></a> +<span class="sourceLineNo">225</span> void delete(long procId);<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> * The parent procedure completed.<a name="line.228"></a> +<span class="sourceLineNo">229</span> * Update the state and mark all the child deleted.<a name="line.229"></a> +<span class="sourceLineNo">230</span> * @param parentProc the parent procedure to serialize and write to the store.<a name="line.230"></a> +<span class="sourceLineNo">231</span> * @param subProcIds the IDs of the sub-procedure to remove.<a name="line.231"></a> +<span class="sourceLineNo">232</span> */<a name="line.232"></a> +<span class="sourceLineNo">233</span> void delete(Procedure<?> parentProc, long[] subProcIds);<a name="line.233"></a> +<span class="sourceLineNo">234</span><a name="line.234"></a> +<span class="sourceLineNo">235</span> /**<a name="line.235"></a> +<span class="sourceLineNo">236</span> * The specified procIds were removed from the executor,<a name="line.236"></a> +<span class="sourceLineNo">237</span> * due to completion, abort or failure.<a name="line.237"></a> +<span class="sourceLineNo">238</span> * The store implementor should remove all the information about the specified procIds.<a name="line.238"></a> +<span class="sourceLineNo">239</span> * @param procIds the IDs of the procedures to remove.<a name="line.239"></a> +<span class="sourceLineNo">240</span> * @param offset the array offset from where to start to delete<a name="line.240"></a> +<span class="sourceLineNo">241</span> * @param count the number of IDs to delete<a name="line.241"></a> +<span class="sourceLineNo">242</span> */<a name="line.242"></a> +<span class="sourceLineNo">243</span> void delete(long[] procIds, int offset, int count);<a name="line.243"></a> +<span class="sourceLineNo">244</span>}<a name="line.244"></a>