Package org.apache.accumulo.core.util.ratelimit

Class SharedRateLimiterFactory

java.lang.Object

org.apache.accumulo.core.util.ratelimit.SharedRateLimiterFactory

public class SharedRateLimiterFactory
extends Object

Provides the ability to retrieve a RateLimiter keyed to a specific string, which will dynamically update its rate according to a specified callback function.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SharedRateLimiterFactory.RateProvider	A callback which provides the current rate for a RateLimiter.
protected class	SharedRateLimiterFactory.SharedRateLimiter

Method Summary

Modifier and Type	Method	Description
RateLimiter	create(String name, SharedRateLimiterFactory.RateProvider rateProvider)	Lookup the RateLimiter associated with the specified name, or create a new one for that name.
static SharedRateLimiterFactory	getInstance(AccumuloConfiguration conf)	Get the singleton instance of the SharedRateLimiterFactory.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static SharedRateLimiterFactory getInstance(AccumuloConfiguration conf)

Get the singleton instance of the SharedRateLimiterFactory.

create

public RateLimiter create(String name,
                          SharedRateLimiterFactory.RateProvider rateProvider)

Lookup the RateLimiter associated with the specified name, or create a new one for that name.

Parameters:

name - key for the rate limiter

rateProvider - a function which can be called to get what the current rate for the rate limiter should be.