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