discord4j.common

Class SimpleBucket

java.lang.Object

discord4j.common.SimpleBucket

All Implemented Interfaces:

RateLimiter

public class SimpleBucket
extends Object
implements RateLimiter

Naive implementation of a rate-limiter that issues a certain amount of permits before requiring consumers to wait until the permits are refilled.

Constructor Summary

Constructors

Constructor and Description
SimpleBucket(long capacity, Duration refillPeriod)

Method Summary

Modifier and Type	Method and Description
long	delayMillisToConsume(long tokens) Calculate the time (in milliseconds) a consumer should delay a call to RateLimiter.tryConsume(int) in order to be successful.
boolean	tryConsume(int numberTokens) Attempt to consume a given number of permits from this limiter.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleBucket

public SimpleBucket(long capacity,
                    Duration refillPeriod)

Method Detail

tryConsume

public boolean tryConsume(int numberTokens)

Description copied from interface: RateLimiter

Attempt to consume a given number of permits from this limiter.

This method does not block or incur in any waiting step. If no permits are available, this method will simply return false. To obtain the delay needed to wait in order to consume the next tokens, see RateLimiter.delayMillisToConsume(long).

Specified by:

tryConsume in interface RateLimiter

Parameters:

numberTokens - the permits to consume

Returns:

true if it was successful, false otherwise

delayMillisToConsume

public long delayMillisToConsume(long tokens)

Description copied from interface: RateLimiter

Calculate the time (in milliseconds) a consumer should delay a call to RateLimiter.tryConsume(int) in order to be successful.

Specified by:

delayMillisToConsume in interface RateLimiter

Parameters:

tokens - the number of permits sought to consume

Returns:

delay in milliseconds that a consumer must wait to consume tokens amount of permits.