org.apache.gobblin.util.limiter

Class RateBasedLimiter

java.lang.Object

org.apache.gobblin.util.limiter.NonRefillableLimiter

org.apache.gobblin.util.limiter.RateBasedLimiter

All Implemented Interfaces:

Limiter

public class RateBasedLimiter
extends NonRefillableLimiter

An implementation of Limiter that limits the rate of some events. This implementation uses Guava's RateLimiter.

acquirePermits(long) is blocking and will always return true after the permits are successfully acquired (probably after being blocked for some amount of time). Permit refills are not supported in this implementation. Also acquirePermits(long) only accepts input arguments that can be safely casted to an integer bounded by Integer.MAX_VALUE.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RateBasedLimiter.Factory

Field Summary

Fields inherited from class org.apache.gobblin.util.limiter.NonRefillableLimiter

NO_OP_CLOSEABLE

Constructor Summary

Constructors

Constructor and Description
RateBasedLimiter(double rateLimit)
RateBasedLimiter(double rateLimit, TimeUnit timeUnit)

Method Summary

Modifier and Type	Method and Description
Closeable	acquirePermits(long permits) Acquire a given number of permits.
void	start() Start the Limiter.
void	stop() Stop the Limiter.

Methods inherited from class java.lang.Object

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

Constructor Detail

RateBasedLimiter

public RateBasedLimiter(double rateLimit)

RateBasedLimiter

public RateBasedLimiter(double rateLimit,
                        TimeUnit timeUnit)

Method Detail

start

public void start()

Description copied from interface: Limiter

Start the Limiter. See Limiter.stop()

acquirePermits

public Closeable acquirePermits(long permits)
                         throws InterruptedException

Description copied from interface: Limiter

Acquire a given number of permits.

Depending on the implementation, the caller of this method may be blocked. It is also up to the caller to decide how to deal with the return value.

Specified by:

acquirePermits in interface Limiter

Overrides:

acquirePermits in class NonRefillableLimiter

Parameters:

permits - number of permits to get

Returns:

a Closeable instance if the requested permits have been successfully acquired, or null if otherwise; in the former case, calling Closeable.close() on the returned Closeable instance will release the acquired permits.

Throws:

InterruptedException - if the caller is interrupted while being blocked

stop

public void stop()

Description copied from interface: Limiter

Stop the Limiter. See Limiter.start()