com.github.agadar.nsapi.ratelimiter

Class RateLimiter

java.lang.Object

com.github.agadar.nsapi.ratelimiter.RateLimiter

Direct Known Subclasses:

DependantRateLimiter

public class RateLimiter
extends Object

Enforces thread-safe rate limiting for x requests per y milliseconds.

Author:

Agadar (https://github.com/Agadar/)

Field Summary

Fields

Modifier and Type	Field and Description
protected int	index The current index in the round buffer, starting at 0.
protected static Logger	logger The logger for this object.
protected long	milliseconds The y in 'x requests per y milliseconds'.
protected long[]	roundBuffer The round buffer we're using, with length set to x in 'x requests per y milliseconds.

Constructor Summary

Constructors

Constructor and Description
RateLimiter(int requests, int milliseconds) Constructs a new RateLimiter.

Method Summary

Modifier and Type	Method and Description
void	Await() Call this method before any code you want to enforce the rate limit on.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final Logger logger

The logger for this object.

roundBuffer

protected final long[] roundBuffer

The round buffer we're using, with length set to x in 'x requests per y milliseconds.

milliseconds

protected final long milliseconds

The y in 'x requests per y milliseconds'.

index

protected int index

The current index in the round buffer, starting at 0.

Constructor Detail

RateLimiter

public RateLimiter(int requests,
                   int milliseconds)

Constructs a new RateLimiter.

Parameters:

requests - the x in 'x requests per y milliseconds'

milliseconds - the y in 'x requests per y milliseconds'

Method Detail

Await

public void Await()

Call this method before any code you want to enforce the rate limit on.