TimeBasedLimiter (Apache HBase 1.4.11 API)

java.lang.Object
- org.apache.hadoop.hbase.quotas.TimeBasedLimiter

All Implemented Interfaces:: QuotaLimiter

@InterfaceAudience.Private
@InterfaceStability.Evolving
public class TimeBasedLimiter
extends Object
implements QuotaLimiter

Simple time based limiter that checks the quota Throttle

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`checkQuota(long writeReqs, long estimateWriteSize, long readReqs, 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`	`getReadAvailable()`
`long`	`getWriteAvailable()`
`void`	`grabQuota(long writeReqs, long writeSize, long readReqs, long readSize)` Removes the specified write and read amount from the quota.
`boolean`	`isBypass()`
`String`	`toString()`
`void`	`update(TimeBasedLimiter other)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - update
```
public void update(TimeBasedLimiter other)
```
  - checkQuota
```
public void checkQuota(long writeReqs,
              long estimateWriteSize,
              long readReqs,
              long estimateReadSize)
                throws ThrottlingException
```
    Description copied from interface: QuotaLimiter
    
    Checks if it is possible to execute the specified operation.
    
    Specified by:
    
    checkQuota in interface QuotaLimiter
    
    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
    
    Throws:
    
    ThrottlingException - thrown if not enough avialable resources to perform operation.
  - grabQuota
```
public void grabQuota(long writeReqs,
             long writeSize,
             long readReqs,
             long readSize)
```
    Description copied from interface: QuotaLimiter
    
    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.
    
    Specified by:
    
    grabQuota in interface QuotaLimiter
    
    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
  - consumeWrite
```
public void consumeWrite(long size)
```
    Description copied from interface: QuotaLimiter
    
    Removes or add back some write amount to the quota. (called at the end of an operation in case the estimate quota was off)
    
    Specified by:
    
    consumeWrite in interface QuotaLimiter
  - consumeRead
```
public void consumeRead(long size)
```
    Description copied from interface: QuotaLimiter
    
    Removes or add back some read amount to the quota. (called at the end of an operation in case the estimate quota was off)
    
    Specified by:
    
    consumeRead in interface QuotaLimiter
  - isBypass
```
public boolean isBypass()
```
    Specified by:
    
    isBypass in interface QuotaLimiter
    
    Returns:
    true if the limiter is a noop
  - getWriteAvailable
```
public long getWriteAvailable()
```
    Specified by:
    
    getWriteAvailable in interface QuotaLimiter
    
    Returns:
    the number of bytes available to write to avoid exceeding the quota
  - getReadAvailable
```
public long getReadAvailable()
```
    Specified by:
    
    getReadAvailable in interface QuotaLimiter
    
    Returns:
    the number of bytes available to read to avoid exceeding the quota
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class TimeBasedLimiter

Method Summary

Methods inherited from class java.lang.Object

Method Detail

update

checkQuota

grabQuota

consumeWrite

consumeRead

isBypass

getWriteAvailable

getReadAvailable

toString