Package org.redisson.api

Interface RRateLimiter

All Superinterfaces:

RExpirable, RExpirableAsync, RObject, RObjectAsync, RRateLimiterAsync

All Known Implementing Classes:

RedissonRateLimiter

public interface RRateLimiter
extends RRateLimiterAsync, RExpirable

Redis based Rate Limiter object.

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method	Description
void	acquire()	Acquires a permit from this RateLimiter, blocking until one is available.
void	acquire(long permits)	Acquires a specified permits from this RateLimiter, blocking until one is available.
long	availablePermits()	Returns amount of available permits.
RateLimiterConfig	getConfig()	Returns current configuration of this RateLimiter object.
void	setRate(RateType mode, long rate, long rateInterval, RateIntervalUnit rateIntervalUnit)	Updates RateLimiter's state and stores config to Redis server.
boolean	tryAcquire()	Acquires a permit only if one is available at the time of invocation.
boolean	tryAcquire(long permits)	Acquires the given number of permits only if all are available at the time of invocation.
boolean	tryAcquire(long permits, long timeout, TimeUnit unit)	Acquires the given number of permits only if all are available within the given waiting time.
boolean	tryAcquire(long timeout, TimeUnit unit)	Acquires a permit from this RateLimiter, if one becomes available within the given waiting time.
boolean	trySetRate(RateType mode, long rate, long rateInterval, RateIntervalUnit rateIntervalUnit)	Initializes RateLimiter's state and stores config to Redis server.

Methods inherited from interface org.redisson.api.RExpirable

clearExpire, expire, expire, expire, expireAt, expireAt, expireIfGreater, expireIfGreater, expireIfLess, expireIfLess, expireIfNotSet, expireIfNotSet, expireIfSet, expireIfSet, getExpireTime, remainTimeToLive

Methods inherited from interface org.redisson.api.RExpirableAsync

clearExpireAsync, expireAsync, expireAsync, expireAsync, expireAtAsync, expireAtAsync, expireIfGreaterAsync, expireIfGreaterAsync, expireIfLessAsync, expireIfLessAsync, expireIfNotSetAsync, expireIfNotSetAsync, expireIfSetAsync, expireIfSetAsync, getExpireTimeAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObject

addListener, copy, delete, dump, getCodec, getIdleTime, getName, isExists, migrate, move, removeListener, rename, renamenx, restore, restore, restoreAndReplace, restoreAndReplace, sizeInMemory, touch, unlink

Methods inherited from interface org.redisson.api.RObjectAsync

addListenerAsync, copyAsync, deleteAsync, dumpAsync, getIdleTimeAsync, isExistsAsync, migrateAsync, moveAsync, removeListenerAsync, renameAsync, renamenxAsync, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, sizeInMemoryAsync, touchAsync, unlinkAsync

Methods inherited from interface org.redisson.api.RRateLimiterAsync

acquireAsync, acquireAsync, availablePermitsAsync, getConfigAsync, setRateAsync, tryAcquireAsync, tryAcquireAsync, tryAcquireAsync, tryAcquireAsync, trySetRateAsync

Method Details

trySetRate

boolean trySetRate(RateType mode,
 long rate,
 long rateInterval,
 RateIntervalUnit rateIntervalUnit)

Initializes RateLimiter's state and stores config to Redis server.

Parameters:

mode - - rate mode

rate - - rate

rateInterval - - rate time interval

rateIntervalUnit - - rate time interval unit

Returns:

true if rate was set and false otherwise

setRate

void setRate(RateType mode,
 long rate,
 long rateInterval,
 RateIntervalUnit rateIntervalUnit)

Updates RateLimiter's state and stores config to Redis server.

Parameters:

mode - - rate mode

rate - - rate

rateInterval - - rate time interval

rateIntervalUnit - - rate time interval unit

tryAcquire

boolean tryAcquire()

Acquires a permit only if one is available at the time of invocation.

Acquires a permit, if one is available and returns immediately, with the value true, reducing the number of available permits by one.

If no permit is available then this method will return immediately with the value false.

Returns:

true if a permit was acquired and false otherwise

tryAcquire

boolean tryAcquire(long permits)

Acquires the given number of permits only if all are available at the time of invocation.

Acquires a permits, if all are available and returns immediately, with the value true, reducing the number of available permits by given number of permits.

If no permits are available then this method will return immediately with the value false.

Parameters:

permits - the number of permits to acquire

Returns:

true if a permit was acquired and false otherwise

acquire

void acquire()

Acquires a permit from this RateLimiter, blocking until one is available.

Acquires a permit, if one is available and returns immediately, reducing the number of available permits by one.

acquire

void acquire(long permits)

Acquires a specified permits from this RateLimiter, blocking until one is available.

Acquires the given number of permits, if they are available and returns immediately, reducing the number of available permits by the given amount.

Parameters:

permits - the number of permits to acquire

tryAcquire

boolean tryAcquire(long timeout,
 TimeUnit unit)

Acquires a permit from this RateLimiter, if one becomes available within the given waiting time.

Acquires a permit, if one is available and returns immediately, with the value true, reducing the number of available permits by one.

If no permit is available then the current thread becomes disabled for thread scheduling purposes and lies dormant until specified waiting time elapses.

If a permit is acquired then the value true is returned.

If the specified waiting time elapses then the value false is returned. If the time is less than or equal to zero, the method will not wait at all.

Parameters:

timeout - the maximum time to wait for a permit

unit - the time unit of the timeout argument

Returns:

true if a permit was acquired and false if the waiting time elapsed before a permit was acquired

tryAcquire

boolean tryAcquire(long permits,
 long timeout,
 TimeUnit unit)

Acquires the given number of permits only if all are available within the given waiting time.

Acquires the given number of permits, if all are available and returns immediately, with the value true, reducing the number of available permits by one.

If no permit is available then the current thread becomes disabled for thread scheduling purposes and lies dormant until the specified waiting time elapses.

If a permits is acquired then the value true is returned.

If the specified waiting time elapses then the value false is returned. If the time is less than or equal to zero, the method will not wait at all.

Parameters:

permits - amount

timeout - the maximum time to wait for a permit

unit - the time unit of the timeout argument

Returns:

true if a permit was acquired and false if the waiting time elapsed before a permit was acquired

getConfig

RateLimiterConfig getConfig()

Returns current configuration of this RateLimiter object.

Returns:

config object

availablePermits

long availablePermits()

Returns amount of available permits.

Returns:

number of permits