net.rithms.riot.api.request.ratelimit

Class BufferedRateLimitHandler

java.lang.Object

net.rithms.riot.api.request.ratelimit.DefaultRateLimitHandler

net.rithms.riot.api.request.ratelimit.BufferedRateLimitHandler

All Implemented Interfaces:

RateLimitHandler

public class BufferedRateLimitHandler
extends DefaultRateLimitHandler

The BufferedRateLimitHandler extends the DefaultRateLimitHandler. It checks the rate limit headers after each request, and if a certain threshold is exceeded, it will soft rate limit the application for a certain time.

If you have a use case where you fire a lot of simultaneous requests (like asynchronously requesting many matches from a match list) using multiple threads or even multiple dedicated servers, if you were to use the DefaultRateLimitHandler, you would already have fired many more requests before you get the first 429 response, resulting in all already fired requests to also result in 429 responses before the DefaultRateLimitHandler can actually prevent further requests from being fired before the rate limit resets. In such a scenario you may want to stop firing new requests for X seconds when you reach X% of your rate limits, so that you have a buffer for already fired requests to end gracefully.

Author:

Daniel 'Linnun' Figge

Nested Class Summary

Nested classes/interfaces inherited from class net.rithms.riot.api.request.ratelimit.DefaultRateLimitHandler

DefaultRateLimitHandler.RateLimit, DefaultRateLimitHandler.RateLimitList

Constructor Summary

Constructors

Constructor and Description
BufferedRateLimitHandler(double threshold, int cooldown) Creates a new BufferedRateLimitHandler.

Method Summary

Modifier and Type	Method and Description
void	onRequestDone(Request request) This method is called for every request after it has finished.

Methods inherited from class net.rithms.riot.api.request.ratelimit.DefaultRateLimitHandler

onRequestAboutToFire

Methods inherited from class java.lang.Object

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

Constructor Detail

BufferedRateLimitHandler

public BufferedRateLimitHandler(double threshold,
                                int cooldown)

Creates a new BufferedRateLimitHandler.

Parameters:

threshold - Rate limit threshold to trigger a soft rate limit (e.g. 0.9 for 90%)

cooldown - Time interval in seconds for an app or method to go on cooldown once the threshold has been exceeded

Method Detail

onRequestDone

public void onRequestDone(Request request)

Description copied from interface: RateLimitHandler

This method is called for every request after it has finished. Here you get the chance to check the request's response and use its header fields to handle your rate limiting logic.

Specified by:

onRequestDone in interface RateLimitHandler

Overrides:

onRequestDone in class DefaultRateLimitHandler