com.github.agadar.nationstates.ratelimiter

Class DependantRateLimiter

java.lang.Object

com.github.agadar.nationstates.ratelimiter.RateLimiter

com.github.agadar.nationstates.ratelimiter.DependantRateLimiter

All Implemented Interfaces:

IRateLimiter

public final class DependantRateLimiter
extends RateLimiter

A rate limiter that is also dependant on another rate limiter.

Author:

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

Constructor Summary

Constructors

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

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

DependantRateLimiter

public DependantRateLimiter(IRateLimiter dependant,
                            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

dependant - the rate limiter this one is dependant on

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

Overrides:

lock in class RateLimiter

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

Overrides:

unlock in class RateLimiter

getMillisecondsBetweenLocks

public int getMillisecondsBetweenLocks()

Specified by:

getMillisecondsBetweenLocks in interface IRateLimiter

Overrides:

getMillisecondsBetweenLocks in class RateLimiter

Returns:

The aforementioned y divided by the aforementioned x.