com.github.agadar.nsapi.ratelimiter

Class DependantRateLimiter

java.lang.Object

com.github.agadar.nsapi.ratelimiter.RateLimiter

com.github.agadar.nsapi.ratelimiter.DependantRateLimiter

public final class DependantRateLimiter
extends RateLimiter

Enforces thread-safe rate limiting for x requests per y milliseconds. This rate limiter is dependant on another rate limiter. In other words, this limiter's Await()- function calls the supplied rate limiter's Await()-function, on top of its normal functionality.

Author:

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

Field Summary

Fields inherited from class com.github.agadar.nsapi.ratelimiter.RateLimiter

index, logger, milliseconds, roundBuffer

Constructor Summary

Constructors

Constructor and Description
DependantRateLimiter(int requests, int milliseconds, RateLimiter dependant) 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

Constructor Detail

DependantRateLimiter

public DependantRateLimiter(int requests,
                            int milliseconds,
                            RateLimiter dependant)

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

Await

public void Await()

Call this method before any code you want to enforce the rate limit on. This code is identical to RateLimiter.Await()'s, save for the call to the dependant's Await()-function.

Overrides:

Await in class RateLimiter