Package org.apache.hadoop.hbase.regionserver.throttle

Interface ThroughputController

All Superinterfaces:

Stoppable

All Known Implementing Classes:

NoLimitThroughputController, PressureAwareCompactionThroughputController, PressureAwareFlushThroughputController, PressureAwareThroughputController

@LimitedPrivate("Configuration")
public interface ThroughputController
extends Stoppable

A utility that constrains the total throughput of one or more simultaneous flows by sleeping when necessary.

Method Summary

Modifier and Type	Method	Description
long	control(String name, long size)	Control the throughput.
void	finish(String name)	Finish the controller.
void	setup(RegionServerServices server)	Setup controller for the given region server.
void	start(String name)	Start the throughput controller.

Methods inherited from interface org.apache.hadoop.hbase.Stoppable

isStopped, stop

Method Details

setup

void setup(RegionServerServices server)

Setup controller for the given region server.

start

void start(String name)

Start the throughput controller.

control

long control(String name,
 long size)
      throws InterruptedException

Control the throughput. Will sleep if too fast.

Returns:

the actual sleep time.

Throws:

InterruptedException

finish

void finish(String name)

Finish the controller. Should call this method in a finally block.