Example usage for Java com.google.common.util.concurrent RateLimiter fields, constructors, methods, implement or subclass
The text is from its open source code.
| double | acquire() Acquires a single permit from this RateLimiter , blocking until the request can be granted. |
| double | acquire(int permits) Acquires the given number of permits from this RateLimiter , blocking until the request can be granted. |
| RateLimiter | create(double permitsPerSecond) Creates a RateLimiter with the specified stable throughput, given as "permits per second" (commonly referred to as QPS, queries per second). |
| RateLimiter | create(double permitsPerSecond, long warmupPeriod, TimeUnit unit) Creates a RateLimiter with the specified stable throughput, given as "permits per second" (commonly referred to as QPS, queries per second), and a warmup period, during which the RateLimiter smoothly ramps up its rate, until it reaches its maximum rate at the end of the period (as long as there are enough requests to saturate it). |
| double | getRate() Returns the stable rate (as permits per seconds ) with which this RateLimiter is configured with. |
| void | setRate(double permitsPerSecond) Updates the stable rate of this RateLimiter , that is, the permitsPerSecond argument provided in the factory method that constructed the RateLimiter . |
| boolean | tryAcquire() Acquires a permit from this RateLimiter if it can be acquired immediately without delay. |
| boolean | tryAcquire(int permits) Acquires permits from this RateLimiter if it can be acquired immediately without delay. |
| boolean | tryAcquire(int permits, long timeout, TimeUnit unit) Acquires the given number of permits from this RateLimiter if it can be obtained without exceeding the specified timeout , or returns false immediately (without waiting) if the permits would not have been granted before the timeout expired. |