| <!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.quotas, interface: QuotaLimiter"> |
| <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.quotas;</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 org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">021</span><span id="line-21">import org.apache.yetus.audience.InterfaceStability;</span> |
| <span class="source-line-no">022</span><span id="line-22"></span> |
| <span class="source-line-no">023</span><span id="line-23">/**</span> |
| <span class="source-line-no">024</span><span id="line-24"> * Internal interface used to interact with the user/table quota.</span> |
| <span class="source-line-no">025</span><span id="line-25"> */</span> |
| <span class="source-line-no">026</span><span id="line-26">@InterfaceAudience.Private</span> |
| <span class="source-line-no">027</span><span id="line-27">@InterfaceStability.Evolving</span> |
| <span class="source-line-no">028</span><span id="line-28">public interface QuotaLimiter {</span> |
| <span class="source-line-no">029</span><span id="line-29"> /**</span> |
| <span class="source-line-no">030</span><span id="line-30"> * Checks if it is possible to execute the specified operation.</span> |
| <span class="source-line-no">031</span><span id="line-31"> * @param writeReqs the write requests that will be checked against the available</span> |
| <span class="source-line-no">032</span><span id="line-32"> * quota</span> |
| <span class="source-line-no">033</span><span id="line-33"> * @param estimateWriteSize the write size that will be checked against the available</span> |
| <span class="source-line-no">034</span><span id="line-34"> * quota</span> |
| <span class="source-line-no">035</span><span id="line-35"> * @param readReqs the read requests that will be checked against the available</span> |
| <span class="source-line-no">036</span><span id="line-36"> * quota</span> |
| <span class="source-line-no">037</span><span id="line-37"> * @param estimateReadSize the read size that will be checked against the available quota</span> |
| <span class="source-line-no">038</span><span id="line-38"> * @param estimateWriteCapacityUnit the write capacity unit that will be checked against the</span> |
| <span class="source-line-no">039</span><span id="line-39"> * available quota</span> |
| <span class="source-line-no">040</span><span id="line-40"> * @param estimateReadCapacityUnit the read capacity unit that will be checked against the</span> |
| <span class="source-line-no">041</span><span id="line-41"> * available quota</span> |
| <span class="source-line-no">042</span><span id="line-42"> * @throws RpcThrottlingException thrown if not enough available resources to perform operation.</span> |
| <span class="source-line-no">043</span><span id="line-43"> */</span> |
| <span class="source-line-no">044</span><span id="line-44"> void checkQuota(long writeReqs, long estimateWriteSize, long readReqs, long estimateReadSize,</span> |
| <span class="source-line-no">045</span><span id="line-45"> long estimateWriteCapacityUnit, long estimateReadCapacityUnit) throws RpcThrottlingException;</span> |
| <span class="source-line-no">046</span><span id="line-46"></span> |
| <span class="source-line-no">047</span><span id="line-47"> /**</span> |
| <span class="source-line-no">048</span><span id="line-48"> * Removes the specified write and read amount from the quota. At this point the write and read</span> |
| <span class="source-line-no">049</span><span id="line-49"> * amount will be an estimate, that will be later adjusted with a consumeWrite()/consumeRead()</span> |
| <span class="source-line-no">050</span><span id="line-50"> * call.</span> |
| <span class="source-line-no">051</span><span id="line-51"> * @param writeReqs the write requests that will be removed from the current quota</span> |
| <span class="source-line-no">052</span><span id="line-52"> * @param writeSize the write size that will be removed from the current quota</span> |
| <span class="source-line-no">053</span><span id="line-53"> * @param readReqs the read requests that will be removed from the current quota</span> |
| <span class="source-line-no">054</span><span id="line-54"> * @param readSize the read size that will be removed from the current quota</span> |
| <span class="source-line-no">055</span><span id="line-55"> * @param writeCapacityUnit the write capacity unit that will be removed from the current quota</span> |
| <span class="source-line-no">056</span><span id="line-56"> * @param readCapacityUnit the read capacity unit num that will be removed from the current quota</span> |
| <span class="source-line-no">057</span><span id="line-57"> */</span> |
| <span class="source-line-no">058</span><span id="line-58"> void grabQuota(long writeReqs, long writeSize, long readReqs, long readSize,</span> |
| <span class="source-line-no">059</span><span id="line-59"> long writeCapacityUnit, long readCapacityUnit);</span> |
| <span class="source-line-no">060</span><span id="line-60"></span> |
| <span class="source-line-no">061</span><span id="line-61"> /**</span> |
| <span class="source-line-no">062</span><span id="line-62"> * Removes or add back some write amount to the quota. (called at the end of an operation in case</span> |
| <span class="source-line-no">063</span><span id="line-63"> * the estimate quota was off)</span> |
| <span class="source-line-no">064</span><span id="line-64"> */</span> |
| <span class="source-line-no">065</span><span id="line-65"> void consumeWrite(long size, long capacityUnit);</span> |
| <span class="source-line-no">066</span><span id="line-66"></span> |
| <span class="source-line-no">067</span><span id="line-67"> /**</span> |
| <span class="source-line-no">068</span><span id="line-68"> * Removes or add back some read amount to the quota. (called at the end of an operation in case</span> |
| <span class="source-line-no">069</span><span id="line-69"> * the estimate quota was off)</span> |
| <span class="source-line-no">070</span><span id="line-70"> */</span> |
| <span class="source-line-no">071</span><span id="line-71"> void consumeRead(long size, long capacityUnit);</span> |
| <span class="source-line-no">072</span><span id="line-72"></span> |
| <span class="source-line-no">073</span><span id="line-73"> /** Returns true if the limiter is a noop */</span> |
| <span class="source-line-no">074</span><span id="line-74"> boolean isBypass();</span> |
| <span class="source-line-no">075</span><span id="line-75"></span> |
| <span class="source-line-no">076</span><span id="line-76"> /** Returns the number of bytes available to read to avoid exceeding the quota */</span> |
| <span class="source-line-no">077</span><span id="line-77"> long getReadAvailable();</span> |
| <span class="source-line-no">078</span><span id="line-78"></span> |
| <span class="source-line-no">079</span><span id="line-79"> /** Returns the maximum number of bytes ever available to read */</span> |
| <span class="source-line-no">080</span><span id="line-80"> long getReadLimit();</span> |
| <span class="source-line-no">081</span><span id="line-81"></span> |
| <span class="source-line-no">082</span><span id="line-82"> /** Returns the maximum number of bytes ever available to write */</span> |
| <span class="source-line-no">083</span><span id="line-83"> long getWriteLimit();</span> |
| <span class="source-line-no">084</span><span id="line-84"></span> |
| <span class="source-line-no">085</span><span id="line-85"> /** Returns the number of bytes available to write to avoid exceeding the quota */</span> |
| <span class="source-line-no">086</span><span id="line-86"> long getWriteAvailable();</span> |
| <span class="source-line-no">087</span><span id="line-87"></span> |
| <span class="source-line-no">088</span><span id="line-88"> /** Returns the maximum number of requests to allow per TimeUnit */</span> |
| <span class="source-line-no">089</span><span id="line-89"> long getRequestNumLimit();</span> |
| <span class="source-line-no">090</span><span id="line-90"></span> |
| <span class="source-line-no">091</span><span id="line-91"> /** Returns the maximum number of reads to allow per TimeUnit */</span> |
| <span class="source-line-no">092</span><span id="line-92"> long getReadNumLimit();</span> |
| <span class="source-line-no">093</span><span id="line-93"></span> |
| <span class="source-line-no">094</span><span id="line-94"> /** Returns the maximum number of writes to allow per TimeUnit */</span> |
| <span class="source-line-no">095</span><span id="line-95"> long getWriteNumLimit();</span> |
| <span class="source-line-no">096</span><span id="line-96"></span> |
| <span class="source-line-no">097</span><span id="line-97">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
