001/**
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.regionserver.throttle;
019
020import org.apache.hadoop.hbase.HBaseInterfaceAudience;
021import org.apache.hadoop.hbase.Stoppable;
022import org.apache.yetus.audience.InterfaceAudience;
023import org.apache.hadoop.hbase.regionserver.RegionServerServices;
024
025/**
026 * A utility that constrains the total throughput of one or more simultaneous flows by
027 * sleeping when necessary.
028 */
029@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.CONFIG)
030public interface ThroughputController extends Stoppable {
031
032  /**
033   * Setup controller for the given region server.
034   */
035  void setup(RegionServerServices server);
036
037  /**
038   * Start the throughput controller.
039   */
040  void start(String name);
041
042  /**
043   * Control the throughput. Will sleep if too fast.
044   * @return the actual sleep time.
045   */
046  long control(String name, long size) throws InterruptedException;
047
048  /**
049   * Finish the controller. Should call this method in a finally block.
050   */
051  void finish(String name);
052}