net.rithms.riot.api.request.ratelimit

Interface RateLimitHandler

All Known Implementing Classes:

BufferedRateLimitHandler, DefaultRateLimitHandler

public interface RateLimitHandler

The interface for handling rate limits

Author:

Daniel 'Linnun' Figge

Method Summary

Modifier and Type	Method and Description
void	onRequestAboutToFire(Request request) This method is called for every request before it is fired to the Riot API.
void	onRequestDone(Request request) This method is called for every request after it has finished.

Method Detail

onRequestAboutToFire

void onRequestAboutToFire(Request request)
                   throws RespectedRateLimitException

This method is called for every request before it is fired to the Riot API. Here you get the chance to respect rate limits and decide to not fire the request by throwing a RespectedRateLimitException instead.

Throws:

RespectedRateLimitException - If the RateLimitHandler decides that a request should not be fired

onRequestDone

void onRequestDone(Request request)

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.