com.mingweisamuel.zyra.util

Class TokenRateLimit

java.lang.Object

com.mingweisamuel.zyra.util.TokenRateLimit

All Implemented Interfaces:

RateLimit

public class TokenRateLimit
extends Object
implements RateLimit

Represents a App or Method rate limit (collection of buckets). Automatically initializes buckets based off of first request response.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TokenRateLimit.RateLimitType Type of rate limit to know what headers to check.

Field Summary

Fields

Modifier and Type	Field and Description
static String	HEADER_RETRY_AFTER Header specifying retry after time in seconds after a 429.
static String	HEADER_X_RATE_LIMIT_TYPE Header specifying which RateLimitType caused a 429.

Constructor Summary

Constructors

Constructor and Description
TokenRateLimit(TokenRateLimit.RateLimitType type, RiotApiConfig config)

Method Summary

Modifier and Type	Method and Description
List<TemporalBucket>	getBuckets() Get the rate limit's buckets.
void	onResponse(org.asynchttpclient.Response response) Callback for when a response returns.
long	retryAfterDelay() Get delay needed to respect retry-after headers.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.mingweisamuel.zyra.util.RateLimit

getOrDelay

Field Detail

HEADER_X_RATE_LIMIT_TYPE

public static final String HEADER_X_RATE_LIMIT_TYPE

Header specifying which RateLimitType caused a 429.

See Also:

Constant Field Values

HEADER_RETRY_AFTER

public static final String HEADER_RETRY_AFTER

Header specifying retry after time in seconds after a 429.

See Also:

Constant Field Values

Constructor Detail

TokenRateLimit

public TokenRateLimit(TokenRateLimit.RateLimitType type,
                      RiotApiConfig config)

Method Detail

retryAfterDelay

public long retryAfterDelay()

Description copied from interface: RateLimit

Get delay needed to respect retry-after headers.

Specified by:

retryAfterDelay in interface RateLimit

Returns:

Milliseconds to delay or -1 if none needed. Zero may be returned and more delay less than one millisecond is required.

getBuckets

public List<TemporalBucket> getBuckets()

Description copied from interface: RateLimit

Get the rate limit's buckets.

Specified by:

getBuckets in interface RateLimit

Returns:

Current buckets.

onResponse

public void onResponse(org.asynchttpclient.Response response)

Description copied from interface: RateLimit

Callback for when a response returns.

Specified by:

onResponse in interface RateLimit

Parameters:

response - Response that applies to this RateLimit.