1 /**
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18 package org.apache.hadoop.hbase.regionserver.compactions;
19
20 import org.apache.hadoop.hbase.HBaseInterfaceAudience;
21 import org.apache.hadoop.hbase.Stoppable;
22 import org.apache.hadoop.hbase.classification.InterfaceAudience;
23 import org.apache.hadoop.hbase.regionserver.RegionServerServices;
24
25 /**
26 * A utility that constrains the total throughput of one or more simultaneous flows (compactions) by
27 * sleeping when necessary.
28 */
29 @InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.CONFIG)
30 public interface CompactionThroughputController extends Stoppable {
31
32 /**
33 * Setup controller for the given region server.
34 */
35 void setup(RegionServerServices server);
36
37 /**
38 * Start a compaction.
39 */
40 void start(String compactionName);
41
42 /**
43 * Control the compaction throughput. Will sleep if too fast.
44 * @return the actual sleep time.
45 */
46 long control(String compactionName, long size) throws InterruptedException;
47
48 /**
49 * Finish a compaction. Should call this method in a finally block.
50 */
51 void finish(String compactionName);
52 }