| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> */<a name="line.17"></a> |
| <span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.client;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.InterruptedIOException;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.Collection;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.function.Consumer;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.HRegionLocation;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.ServerName;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span><a name="line.26"></a> |
| <span class="sourceLineNo">027</span>/**<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * An interface for client request scheduling algorithm.<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> */<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>@InterfaceAudience.Public<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>public interface RequestController {<a name="line.31"></a> |
| <span class="sourceLineNo">032</span><a name="line.32"></a> |
| <span class="sourceLineNo">033</span> @InterfaceAudience.Public<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> public enum ReturnCode {<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> /**<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * Accept current row.<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> */<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> INCLUDE,<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> /**<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * Skip current row.<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> */<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> SKIP,<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> /**<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * No more row can be included.<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> */<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> END<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> }<a name="line.47"></a> |
| <span class="sourceLineNo">048</span><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> /**<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * Picks up the valid data.<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> */<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> @InterfaceAudience.Public<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> public interface Checker {<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> /**<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * Checks the data whether it is valid to submit.<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * @param loc the destination of data<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * @param row the data to check<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * @return describe the decision for the row<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> */<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> ReturnCode canTakeRow(HRegionLocation loc, Row row);<a name="line.60"></a> |
| <span class="sourceLineNo">061</span><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> /**<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * Reset the state of the scheduler when completing the iteration of rows.<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * @throws InterruptedIOException some controller may wait for some busy region or RS to<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * complete the undealt request.<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> */<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> void reset() throws InterruptedIOException;<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> }<a name="line.68"></a> |
| <span class="sourceLineNo">069</span><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> /** Returns A new checker for evaluating a batch rows. */<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> Checker newChecker();<a name="line.71"></a> |
| <span class="sourceLineNo">072</span><a name="line.72"></a> |
| <span class="sourceLineNo">073</span> /**<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * Increment the counter if we build a valid task.<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * @param regions The destination of task<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * @param sn The target server<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> */<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> void incTaskCounters(Collection<byte[]> regions, ServerName sn);<a name="line.78"></a> |
| <span class="sourceLineNo">079</span><a name="line.79"></a> |
| <span class="sourceLineNo">080</span> /**<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * Decrement the counter if a task is accomplished.<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * @param regions The destination of task<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * @param sn The target server<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> */<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> void decTaskCounters(Collection<byte[]> regions, ServerName sn);<a name="line.85"></a> |
| <span class="sourceLineNo">086</span><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> /** Returns The number of running task. */<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> long getNumberOfTasksInProgress();<a name="line.88"></a> |
| <span class="sourceLineNo">089</span><a name="line.89"></a> |
| <span class="sourceLineNo">090</span> /**<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * Waits for the running tasks to complete. If there are specified threshold and trigger, the<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * implementation should wake up once in a while for checking the threshold and calling trigger.<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * @param max This method will return if the number of running tasks is less than or<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * equal to max.<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * @param id the caller's id<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * @param periodToTrigger The period to invoke the trigger. This value is a hint. The real period<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * depends on the implementation.<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * @param trigger The object to call periodically.<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * @throws java.io.InterruptedIOException If the waiting is interrupted<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> */<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> void waitForMaximumCurrentTasks(long max, long id, int periodToTrigger, Consumer<Long> trigger)<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> throws InterruptedIOException;<a name="line.102"></a> |
| <span class="sourceLineNo">103</span><a name="line.103"></a> |
| <span class="sourceLineNo">104</span> /**<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * Wait until there is at least one slot for a new task.<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * @param id the caller's id<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * @param periodToTrigger The period to invoke the trigger. This value is a hint. The real period<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * depends on the implementation.<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * @param trigger The object to call periodically.<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * @throws java.io.InterruptedIOException If the waiting is interrupted<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> */<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> void waitForFreeSlot(long id, int periodToTrigger, Consumer<Long> trigger)<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> throws InterruptedIOException;<a name="line.113"></a> |
| <span class="sourceLineNo">114</span>}<a name="line.114"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
