com.github.agadar.nationstates.ratelimiter

Interface IRateLimiter

All Known Implementing Classes:

DependantRateLimiter, RateLimiter

public interface IRateLimiter

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

Author:

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

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.

Method Detail

lock

boolean lock()

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.

Returns:

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

unlock

void unlock()

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

getMillisecondsBetweenLocks

int getMillisecondsBetweenLocks()

Returns:

The aforementioned y divided by the aforementioned x.