org.apache.hadoop.hbase.quotas

Class AverageIntervalRateLimiter

java.lang.Object

org.apache.hadoop.hbase.quotas.RateLimiter

org.apache.hadoop.hbase.quotas.AverageIntervalRateLimiter

@InterfaceAudience.Private
 @InterfaceStability.Evolving
public class AverageIntervalRateLimiter
extends RateLimiter

This limiter will refill resources at every TimeUnit/resources interval. For example: For a limiter configured with 10resources/second, then 1 resource will be refilled after every 100ms (1sec/10resources)

Field Summary

Fields inherited from class org.apache.hadoop.hbase.quotas.RateLimiter

QUOTA_RATE_LIMITER_CONF_KEY

Constructor Summary

Constructors

Constructor and Description
AverageIntervalRateLimiter()

Method Summary

Modifier and Type	Method and Description
long	getNextRefillTime()
long	getWaitInterval(long limit, long available, long amount) Time in milliseconds to wait for before requesting to consume 'amount' resource.
long	refill(long limit) Refill the available units w.r.t the elapsed time.
void	setNextRefillTime(long nextRefillTime)

Methods inherited from class org.apache.hadoop.hbase.quotas.RateLimiter

canExecute, canExecute, consume, consume, getAvailable, getLimit, getTimeUnitInMillis, isBypass, set, toString, update, waitInterval, waitInterval

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AverageIntervalRateLimiter

public AverageIntervalRateLimiter()

Method Detail

refill

public long refill(long limit)

Description copied from class: RateLimiter

Refill the available units w.r.t the elapsed time.

Parameters:

limit - Maximum available resource units that can be refilled to.

Returns:

how many resource units may be refilled ?

getWaitInterval

public long getWaitInterval(long limit,
                            long available,
                            long amount)

Description copied from class: RateLimiter

Time in milliseconds to wait for before requesting to consume 'amount' resource.

Parameters:

limit - Maximum available resource units that can be refilled to.

available - Currently available resource units

amount - Resources for which time interval to calculate for

Returns:

estimate of the ms required to wait before being able to provide 'amount' resources.

setNextRefillTime

public void setNextRefillTime(long nextRefillTime)

Specified by:

setNextRefillTime in class RateLimiter

getNextRefillTime

public long getNextRefillTime()

Specified by:

getNextRefillTime in class RateLimiter