es.moki.ratelimitj.core.limiter.concurrent

Class ConcurrentLimitRule

java.lang.Object

es.moki.ratelimitj.core.limiter.concurrent.ConcurrentLimitRule

@ParametersAreNonnullByDefault
public class ConcurrentLimitRule
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
int	getConcurrentLimit()
java.lang.String	getName()
long	getTimeoutMillis()
int	hashCode()
static ConcurrentLimitRule	of(int concurrentLimit, java.util.concurrent.TimeUnit timeOutUnit, long timeOut) Initialise a concurrent rate limit.
ConcurrentLimitRule	withName(java.lang.String name) Applies a name to the rate limit that is useful for metrics.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static ConcurrentLimitRule of(int concurrentLimit,
                                     java.util.concurrent.TimeUnit timeOutUnit,
                                     long timeOut)

Initialise a concurrent rate limit.

Parameters:

concurrentLimit - The concurrent limit.

timeOutUnit - The time unit.

timeOut - A timeOut for the checkout baton.

Returns:

A concurrent limit rule.

withName

public ConcurrentLimitRule withName(java.lang.String name)

Applies a name to the rate limit that is useful for metrics.

Parameters:

name - Defines a descriptive name for the rule limit.

Returns:

a limit rule

getConcurrentLimit

public int getConcurrentLimit()

getTimeoutMillis

public long getTimeoutMillis()

getName

public java.lang.String getName()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object