Package com.linkedin.venice.throttle

Class GuavaRateLimiter

java.lang.Object

com.linkedin.venice.throttle.GuavaRateLimiter

All Implemented Interfaces:

VeniceRateLimiter

public class GuavaRateLimiter
extends Object
implements VeniceRateLimiter

A wrapper around Guava's RateLimiter to provide a common interface for rate limiting.

Nested Class Summary

Nested classes/interfaces inherited from interface com.linkedin.venice.throttle.VeniceRateLimiter

VeniceRateLimiter.RateLimiterType

Constructor Summary

Constructors

Constructor	Description
GuavaRateLimiter(long permitsPerSecond)

Method Summary

Modifier and Type	Method	Description
void	acquirePermit(int units)	Acquire a permit, blocking until one is available.
long	getQuota()
void	setQuota(long quota)	The following methods are used only when checking if the new quota requests are different from the existing quota.
String	toString()
boolean	tryAcquirePermit(int units)	Try to acquire permit for the given rcu.

Methods inherited from class java.lang.Object

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

Constructor Details

GuavaRateLimiter

public GuavaRateLimiter(long permitsPerSecond)

Method Details

tryAcquirePermit

public boolean tryAcquirePermit(int units)

Description copied from interface: VeniceRateLimiter

Try to acquire permit for the given rcu. Will not block if permit is not available.

Specified by:

tryAcquirePermit in interface VeniceRateLimiter

Parameters:

units - Number of units to acquire.

Returns:

true if permit is acquired, false otherwise.

acquirePermit

public void acquirePermit(int units)

Description copied from interface: VeniceRateLimiter

Acquire a permit, blocking until one is available. Default implementation polls VeniceRateLimiter.tryAcquirePermit(int) with a 10ms sleep. Implementations with native blocking (e.g. Guava RateLimiter) should override for precision.

Specified by:

acquirePermit in interface VeniceRateLimiter

setQuota

public void setQuota(long quota)

Description copied from interface: VeniceRateLimiter

The following methods are used only when checking if the new quota requests are different from the existing quota.

Specified by:

setQuota in interface VeniceRateLimiter

getQuota

public long getQuota()

Specified by:

getQuota in interface VeniceRateLimiter

toString

public String toString()

Overrides:

toString in class Object