org.apache.gobblin.util.limiter

Class MultiLimiter

java.lang.Object

org.apache.gobblin.util.limiter.MultiLimiter

All Implemented Interfaces:

Limiter

public class MultiLimiter
extends Object
implements Limiter

A Limiter that contains multiple underlying Limiters and requests permits from all those limiters.

Permits are requested serially from the underlying brokers in the order they appear in the constructor. If an underlying limiter is unable to provide permits, permits from previous underlying limiters are closed. However, for NonRefillableLimiters, the permits are lost permanently.

Note: MultiLimiter does some optimization of the underlying limiters: * underlying MultiLimiters are opened, and their underlying limiters are used instead. * NoopLimiters are ignored. * underlying Limiters are deduplicated to avoid requesting permits from the same limiter twice. Deduplication is done based on the Object.equals(Object) method of the underlying limiters.

Constructor Summary

Constructors

Constructor and Description
MultiLimiter(Limiter... underlyingLimiters)

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

MultiLimiter

public MultiLimiter(Limiter... underlyingLimiters)

Method Detail

start

public void start()

Description copied from interface: Limiter

Start the Limiter. See Limiter.stop()

Specified by:

start in interface Limiter

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

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()

Specified by:

stop in interface Limiter