org.apache.gobblin.util.limiter

Interface Limiter

All Known Implementing Classes:

CountBasedLimiter, MultiLimiter, NonRefillableLimiter, NoopLimiter, PoolBasedLimiter, RateBasedLimiter, TimeBasedLimiter

public interface Limiter

An interface for classes that implement some logic limiting on the occurrences of some events, e.g., data record extraction using an Extractor.

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.

Method Detail

start

void start()

Start the Limiter. See stop()

acquirePermits

Closeable acquirePermits(long permits)
                  throws InterruptedException

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.

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

void stop()

Stop the Limiter. See start()