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	checkQuota(long writeReqs, long estimateWriteSize, long readReqs, long estimateReadSize, long estimateWriteCapacityUnit, long estimateReadCapacityUnit, boolean isAtomic, long estimateHandlerThreadUsageMs) Checks if it is possible to execute the specified operation.
void	consumeRead(long size, long capacityUnit, boolean isAtomic) Removes or add back some read amount to the quota.
void	consumeTime(long handlerMillisUsed) Removes or add back some handler thread usage milliseconds to the quota.
void	consumeWrite(long size, long capacityUnit, boolean isAtomic) Removes or add back some write amount to the quota.
long	getReadAvailable() Returns the number of bytes available to read to avoid exceeding the quota
long	getReadLimit() Returns the maximum number of bytes ever available to read
long	getReadNumLimit() Returns the maximum number of reads to allow per TimeUnit
long	getRequestNumLimit() Returns the maximum number of requests to allow per TimeUnit
long	getWriteAvailable() Returns the number of bytes available to write to avoid exceeding the quota
long	getWriteLimit() Returns the maximum number of bytes ever available to write
long	getWriteNumLimit() Returns the maximum number of writes to allow per TimeUnit
void	grabQuota(long writeReqs, long writeSize, long readReqs, long readSize, long writeCapacityUnit, long readCapacityUnit, boolean isAtomic, long estimateHandlerThreadUsageMs) Removes the specified write and read amount from the quota.
boolean	isBypass() Returns true if the limiter is a noop

Method Detail

checkQuota

void checkQuota(long writeReqs,
                long estimateWriteSize,
                long readReqs,
                long estimateReadSize,
                long estimateWriteCapacityUnit,
                long estimateReadCapacityUnit,
                boolean isAtomic,
                long estimateHandlerThreadUsageMs)
         throws RpcThrottlingException

Checks if it is possible to execute the specified operation.

Parameters:

writeReqs - the write requests that will be checked against the available quota

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

readReqs - the read requests that will be checked against the available quota

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

estimateWriteCapacityUnit - the write capacity unit that will be checked against the available quota

estimateReadCapacityUnit - the read capacity unit that will be checked against the available quota

isAtomic - if the request performs an atomic operation

estimateHandlerThreadUsageMs - the estimated handler usage time in ms that will be checked against the available quota

Throws:

RpcThrottlingException - thrown if not enough available resources to perform operation.

grabQuota

void grabQuota(long writeReqs,
               long writeSize,
               long readReqs,
               long readSize,
               long writeCapacityUnit,
               long readCapacityUnit,
               boolean isAtomic,
               long estimateHandlerThreadUsageMs)

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:

writeReqs - the write requests that will be removed from the current quota

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

readReqs - the read requests that will be removed from the current quota

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

writeCapacityUnit - the write capacity unit that will be removed from the current quota

readCapacityUnit - the read capacity unit num that will be removed from the current quota

isAtomic - if the request performs an atomic operation

estimateHandlerThreadUsageMs - the estimated handler usage time in ms that will be removed from the available quota

consumeWrite

void consumeWrite(long size,
                  long capacityUnit,
                  boolean isAtomic)

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,
                 long capacityUnit,
                 boolean isAtomic)

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

consumeTime

void consumeTime(long handlerMillisUsed)

Removes or add back some handler thread usage milliseconds to the quota. (called at the end of an operation in case the estimate quota was off)

Parameters:

handlerMillisUsed - the actual elapsed time used processing the request

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

getReadLimit

long getReadLimit()

Returns the maximum number of bytes ever available to read

getWriteLimit

long getWriteLimit()

Returns the maximum number of bytes ever available to write

getWriteAvailable

long getWriteAvailable()

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

getRequestNumLimit

long getRequestNumLimit()

Returns the maximum number of requests to allow per TimeUnit

getReadNumLimit

long getReadNumLimit()

Returns the maximum number of reads to allow per TimeUnit

getWriteNumLimit

long getWriteNumLimit()

Returns the maximum number of writes to allow per TimeUnit