Class TaskTokenBucketRateLimiter

java.lang.Object

com.cotani.task.throttle.TaskTokenBucketRateLimiter

All Implemented Interfaces:

RateLimiter

@InternalApi
public final class TaskTokenBucketRateLimiter
extends Object
implements RateLimiter

Method Summary

Modifier and Type	Method	Description
static TaskTokenBucketRateLimiter	create(long capacity, long refillTokens, Duration refillPeriod)
static TaskTokenBucketRateLimiter	create(long capacity, Duration refillPeriod)
Duration	retryDelay()	Returns the suggested non-negative delay to wait before the next RateLimiter.tryAcquire() attempt.
boolean	tryAcquire()

Methods inherited from class Object

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

Method Details

create

public static TaskTokenBucketRateLimiter create(long capacity,
 Duration refillPeriod)

create

public static TaskTokenBucketRateLimiter create(long capacity,
 long refillTokens,
 Duration refillPeriod)

tryAcquire

public boolean tryAcquire()

Specified by:

tryAcquire in interface RateLimiter

retryDelay

public Duration retryDelay()

Description copied from interface: RateLimiter

Returns the suggested non-negative delay to wait before the next RateLimiter.tryAcquire() attempt. A zero duration means the caller may retry immediately.

Specified by:

retryDelay in interface RateLimiter