Package com.google.common.util.concurrent

Class RecyclableRateLimiterWithMetrics

java.lang.Object

com.google.common.util.concurrent.RecyclableRateLimiterWithMetrics

All Implemented Interfaces:

RecyclableRateLimiter

public class RecyclableRateLimiterWithMetrics
extends Object
implements RecyclableRateLimiter

A decorator for RecyclableRateLimiter that adds metrics for permits-related operations.

Author:

vasily@wavefront.com

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RecyclableRateLimiterWithMetrics.RateLimiterMetricsContainer

Constructor Summary

Constructors

Constructor	Description
RecyclableRateLimiterWithMetrics(RecyclableRateLimiter delegate, String prefix)
RecyclableRateLimiterWithMetrics(RecyclableRateLimiter delegate, Supplier<RecyclableRateLimiterWithMetrics.RateLimiterMetricsContainer> metrics)

Method Summary

Modifier and Type	Method	Description
double	acquire(int permits)	Acquires the requested number of permits, waiting until enough permits are available.
double	getRate()	Returns the currently configured rate per second at which new permits become available.
boolean	immediatelyAvailable(int permits)	Checks whether there's enough permits accumulated to cover the number of requested permits.
void	recyclePermits(int permits)	Return the specified number of permits back to the pool.
void	setRate(double rate)	Updates the rate for this RateLimiter.
boolean	tryAcquire(int permits)	Acquires the requested number of permits only if can be acquired without wait.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.common.util.concurrent.RecyclableRateLimiter

acquire, tryAcquire

Constructor Detail

RecyclableRateLimiterWithMetrics

public RecyclableRateLimiterWithMetrics(RecyclableRateLimiter delegate,
                                        String prefix)

Parameters:

delegate - RecyclableRateLimiter delegate

prefix - metric prefix

RecyclableRateLimiterWithMetrics

public RecyclableRateLimiterWithMetrics(RecyclableRateLimiter delegate,
                                        Supplier<RecyclableRateLimiterWithMetrics.RateLimiterMetricsContainer> metrics)

Parameters:

delegate - RecyclableRateLimiter delegate

metrics - a supplier with

Method Detail

getRate

public double getRate()

Description copied from interface: RecyclableRateLimiter

Returns the currently configured rate per second at which new permits become available.

Specified by:

getRate in interface RecyclableRateLimiter

Returns:

number of permits per second

setRate

public void setRate(double rate)

Description copied from interface: RecyclableRateLimiter

Updates the rate for this RateLimiter.

Specified by:

setRate in interface RecyclableRateLimiter

Parameters:

rate - new rate per second

acquire

public double acquire(int permits)

Description copied from interface: RecyclableRateLimiter

Acquires the requested number of permits, waiting until enough permits are available.

Specified by:

acquire in interface RecyclableRateLimiter

Parameters:

permits - number of permits to request

Returns:

wait time in milliseconds

tryAcquire

public boolean tryAcquire(int permits)

Description copied from interface: RecyclableRateLimiter

Acquires the requested number of permits only if can be acquired without wait.

Specified by:

tryAcquire in interface RecyclableRateLimiter

Parameters:

permits - number of permits to request

Returns:

true if permits were acquired

recyclePermits

public void recyclePermits(int permits)

Description copied from interface: RecyclableRateLimiter

Return the specified number of permits back to the pool.

Specified by:

recyclePermits in interface RecyclableRateLimiter

Parameters:

permits - number of permits to return

immediatelyAvailable

public boolean immediatelyAvailable(int permits)

Description copied from interface: RecyclableRateLimiter

Checks whether there's enough permits accumulated to cover the number of requested permits.

Specified by:

immediatelyAvailable in interface RecyclableRateLimiter

Parameters:

permits - permits to check

Returns:

true if enough accumulated permits