com.google.common.util.concurrent

Class RecyclableRateLimiter

java.lang.Object

com.google.common.util.concurrent.RateLimiter

com.google.common.util.concurrent.RecyclableRateLimiter

public class RecyclableRateLimiter
extends com.google.common.util.concurrent.RateLimiter

An alternative RateLimiter implementation that allows to "return" unused permits back to the pool to handle retries gracefully and allow precise control over outgoing rate, plus allows accumulating "credits" for unused permits over a time window other than 1 second. Created by: [email protected], with portions from Guava library source code

Method Summary

Modifier and Type	Method and Description
static RecyclableRateLimiter	create(double permitsPerSecond, double maxBurstSeconds)
double	getAvailablePermits() Get the number of accumulated permits
void	recyclePermits(int permits) Return the specified number of permits back to the pool

Methods inherited from class com.google.common.util.concurrent.RateLimiter

acquire, acquire, create, create, getRate, setRate, toString, tryAcquire, tryAcquire, tryAcquire, tryAcquire

Methods inherited from class java.lang.Object

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

Method Detail

create

public static RecyclableRateLimiter create(double permitsPerSecond,
                                           double maxBurstSeconds)

getAvailablePermits

public double getAvailablePermits()

Get the number of accumulated permits

Returns:

number of accumulated permits

recyclePermits

public void recyclePermits(int permits)

Return the specified number of permits back to the pool

Parameters:

permits - number of permits to return