com.mingweisamuel.zyra.util

Interface RateLimit

All Known Implementing Classes:

TokenRateLimit

public interface RateLimit

Method Summary

Modifier and Type	Method and Description
List<TemporalBucket>	getBuckets() Get the rate limit's buckets.
static long	getOrDelay(RateLimit... rateLimits) Ensures that all provided rateLimits can be obeyed, or returns an estimated delay in milliseconds to wait.
void	onResponse(org.asynchttpclient.Response response) Callback for when a response returns.
long	retryAfterDelay() Get delay needed to respect retry-after headers.

Method Detail

retryAfterDelay

long retryAfterDelay()

Get delay needed to respect retry-after headers.

Returns:

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

getBuckets

List<TemporalBucket> getBuckets()

Get the rate limit's buckets.

Returns:

Current buckets.

onResponse

void onResponse(org.asynchttpclient.Response response)

Callback for when a response returns.

Parameters:

response - Response that applies to this RateLimit.

getOrDelay

static long getOrDelay(RateLimit... rateLimits)

Ensures that all provided rateLimits can be obeyed, or returns an estimated delay in milliseconds to wait.

Parameters:

rateLimits - Rate limits to obey.

Returns:

-1 if success, or a non-negative time to delay in milliseconds.