es.moki.ratelimitj.core.limiter.request

Interface RequestRateLimiter

public interface RequestRateLimiter

A synchronous request rate limiter interface.

Method Summary

Modifier and Type	Method and Description
boolean	geLimitWhenIncremented(java.lang.String key) Determine if the given key, after incrementing by one, is >= the configured rate limit.
boolean	geLimitWhenIncremented(java.lang.String key, int weight) Determine if the given key, after incrementing by the given weight, is >= the configured rate limit.
boolean	overLimitWhenIncremented(java.lang.String key) Determine if the given key, after incrementing by one, has exceeded the configured rate limit.
boolean	overLimitWhenIncremented(java.lang.String key, int weight) Determine if the given key, after incrementing by the given weight, has exceeded the configured rate limit.
boolean	resetLimit(java.lang.String key) Resets the accumulated rate for the given key.

Method Detail

overLimitWhenIncremented

boolean overLimitWhenIncremented(java.lang.String key)

Determine if the given key, after incrementing by one, has exceeded the configured rate limit.

Parameters:

key - key.

Returns:

true if the key is over the limit, otherwise false

overLimitWhenIncremented

boolean overLimitWhenIncremented(java.lang.String key,
                                 int weight)

Determine if the given key, after incrementing by the given weight, has exceeded the configured rate limit.

Parameters:

key - key.

weight - A variable weight.

Returns:

true if the key has exceeded the limit, otherwise false .

geLimitWhenIncremented

boolean geLimitWhenIncremented(java.lang.String key)

Determine if the given key, after incrementing by one, is >= the configured rate limit.

Parameters:

key - key.

Returns:

true if the key is >== the limit, otherwise false .

geLimitWhenIncremented

boolean geLimitWhenIncremented(java.lang.String key,
                               int weight)

Determine if the given key, after incrementing by the given weight, is >= the configured rate limit.

Parameters:

key - key.

weight - A variable weight.

Returns:

true if the key is >== the limit, otherwise false .

resetLimit

boolean resetLimit(java.lang.String key)

Resets the accumulated rate for the given key.

Parameters:

key - key.

Returns:

true if the key existed, otherwise false .