Package io.kubernetes.client.extended.workqueue.ratelimiter

Class BucketRateLimiter<T>

java.lang.Object

io.kubernetes.client.extended.workqueue.ratelimiter.BucketRateLimiter<T>

All Implemented Interfaces:

RateLimiter<T>

public class BucketRateLimiter<T>
extends Object
implements RateLimiter<T>

A light-weight token bucket implementation for RateLimiter.

Constructor Summary

Constructors

Constructor	Description
BucketRateLimiter(long capacity, long tokensGeneratedInPeriod, Duration period)

Method Summary

Modifier and Type	Method	Description
void	forget(T item)	Forget indicates that an item is finished being retried.
int	numRequeues(T item)
Duration	when(T item)	When gets an item and gets to decide how long that item should wait

Methods inherited from class java.lang.Object

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

Constructor Details

BucketRateLimiter

public BucketRateLimiter(long capacity,
 long tokensGeneratedInPeriod,
 Duration period)

Parameters:

capacity - Capacity is the maximum number of tokens can be consumed.

tokensGeneratedInPeriod - Tokens generated in period.

period - Period that generating specific number of tokens.

Method Details

when

public Duration when(T item)

Description copied from interface: RateLimiter

When gets an item and gets to decide how long that item should wait

Specified by:

when in interface RateLimiter<T>

Parameters:

item - Item that should wait

forget

public void forget(T item)

Description copied from interface: RateLimiter

Forget indicates that an item is finished being retried. Doesn't matter whether its for perm failing or for success, we'll stop tracking it

Specified by:

forget in interface RateLimiter<T>

Parameters:

item - Item will be forget

numRequeues

public int numRequeues(T item)

Specified by:

numRequeues in interface RateLimiter<T>

Returns:

number of how many failures the item has had