com.github.agadar.nationstates.ratelimiter

Class RateLimiter

java.lang.Object

com.github.agadar.nationstates.ratelimiter.RateLimiter

All Implemented Interfaces:

IRateLimiter

Direct Known Subclasses:

DependantRateLimiter

public class RateLimiter
extends Object
implements IRateLimiter

Author:

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

Constructor Summary

Constructors

Constructor and Description
RateLimiter(int requests, int milliseconds)

Method Summary

Modifier and Type	Method and Description
int	getMillisecondsBetweenLocks()
boolean	lock() Call this BEFORE executing code that needs to be rate limited.
void	unlock() Call this AFTER executing code that needs to be rate limited.

Methods inherited from class java.lang.Object

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

Constructor Detail

RateLimiter

public RateLimiter(int requests,
                   int milliseconds)

Parameters:

requests - the x in x requests per y milliseconds

milliseconds - the y in x requests per y milliseconds

Method Detail

lock

public boolean lock()

Description copied from interface: IRateLimiter

Call this BEFORE executing code that needs to be rate limited. Blocks the thread as long as necessary so that the rate limit isn't violated.

Specified by:

lock in interface IRateLimiter

Returns:

True if the thread was not interrupted while waiting to continue.

unlock

public void unlock()

Description copied from interface: IRateLimiter

Call this AFTER executing code that needs to be rate limited. Failure to call this will result in other threads being blocked indefinitely.

Specified by:

unlock in interface IRateLimiter

getMillisecondsBetweenLocks

public int getMillisecondsBetweenLocks()

Specified by:

getMillisecondsBetweenLocks in interface IRateLimiter

Returns:

The aforementioned y divided by the aforementioned x.