org.apache.hadoop.hbase.quotas

Interface QuotaLimiter

All Known Implementing Classes:

TimeBasedLimiter

@InterfaceAudience.Private
 @InterfaceStability.Evolving
public interface QuotaLimiter

Internal interface used to interact with the user/table quota.

Method Summary

Modifier and Type	Method and Description
void	addOperationSize(OperationQuota.OperationType type, long size) Add the average size of the specified operation type.
void	checkQuota(long estimateWriteSize, long estimateReadSize) Checks if it is possible to execute the specified operation.
void	consumeRead(long size) Removes or add back some read amount to the quota.
void	consumeWrite(long size) Removes or add back some write amount to the quota.
long	getAvgOperationSize(OperationQuota.OperationType type)
long	getReadAvailable()
long	getWriteAvailable()
void	grabQuota(long writeSize, long readSize) Removes the specified write and read amount from the quota.
boolean	isBypass()

Method Detail

checkQuota

void checkQuota(long estimateWriteSize,
                long estimateReadSize)
         throws ThrottlingException

Checks if it is possible to execute the specified operation.

Parameters:

estimateWriteSize - the write size that will be checked against the available quota

estimateReadSize - the read size that will be checked against the available quota

Throws:

ThrottlingException - thrown if not enough avialable resources to perform operation.

grabQuota

void grabQuota(long writeSize,
               long readSize)

Removes the specified write and read amount from the quota. At this point the write and read amount will be an estimate, that will be later adjusted with a consumeWrite()/consumeRead() call.

Parameters:

writeSize - the write size that will be removed from the current quota

readSize - the read size that will be removed from the current quota

consumeWrite

void consumeWrite(long size)

Removes or add back some write amount to the quota. (called at the end of an operation in case the estimate quota was off)

consumeRead

void consumeRead(long size)

Removes or add back some read amount to the quota. (called at the end of an operation in case the estimate quota was off)

isBypass

boolean isBypass()

Returns:

true if the limiter is a noop

getReadAvailable

long getReadAvailable()

Returns:

the number of bytes available to read to avoid exceeding the quota

getWriteAvailable

long getWriteAvailable()

Returns:

the number of bytes available to write to avoid exceeding the quota

addOperationSize

void addOperationSize(OperationQuota.OperationType type,
                      long size)

Add the average size of the specified operation type. The average will be used as estimate for the next operations.

getAvgOperationSize

long getAvgOperationSize(OperationQuota.OperationType type)

Returns:

the average data size of the specified operation