org.redisson

Class RedissonRateLimiter

java.lang.Object

org.redisson.RedissonObject

org.redisson.RedissonRateLimiter

All Implemented Interfaces:

RExpirable, RExpirableAsync, RObject, RObjectAsync, RRateLimiter, RRateLimiterAsync

public class RedissonRateLimiter
extends RedissonObject
implements RRateLimiter

Author:

Nikita Koksharov

Field Summary

Fields inherited from class org.redisson.RedissonObject

codec, commandExecutor, name

Constructor Summary

Constructors

Constructor and Description
RedissonRateLimiter(CommandAsyncExecutor commandExecutor, String name)

Method Summary

Modifier and Type	Method and 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.
RFuture<Void>	acquireAsync() Acquires a permit from this RateLimiter, blocking until one is available.
RFuture<Void>	acquireAsync(long permits) Acquires a specified permits from this RateLimiter, blocking until one is available.
long	availablePermits() Returns amount of available permits.
RFuture<Long>	availablePermitsAsync() Returns amount of available permits.
boolean	clearExpire() Clear an expire timeout or expire date for object.
RFuture<Boolean>	clearExpireAsync() Clear an expire timeout or expire date for object in async mode.
protected RFuture<Boolean>	clearExpireAsync(String... keys)
RFuture<Boolean>	deleteAsync() Delete object in async mode
boolean	expire(Instant instant) Set an expire date for object.
boolean	expire(long timeToLive, TimeUnit timeUnit) Set a timeout for object.
RFuture<Boolean>	expireAsync(Instant instant) Set an expire date for object.
RFuture<Boolean>	expireAsync(long timeToLive, TimeUnit timeUnit) Set a timeout for object in async mode.
protected RFuture<Boolean>	expireAsync(long timeToLive, TimeUnit timeUnit, String... keys)
boolean	expireAt(Date timestamp) Use RExpirable.expire(Instant) instead
boolean	expireAt(long timestamp) Use RExpirable.expire(Instant) instead
RFuture<Boolean>	expireAtAsync(Date timestamp) Use RExpirableAsync.expireAsync(Instant) instead
RFuture<Boolean>	expireAtAsync(long timestamp) Use RExpirableAsync.expireAsync(Instant) instead
protected RFuture<Boolean>	expireAtAsync(long timestamp, String... keys)
RateLimiterConfig	getConfig() Returns current configuration of this RateLimiter object.
RFuture<RateLimiterConfig>	getConfigAsync() Returns current configuration of this RateLimiter object.
long	remainTimeToLive() Remaining time to live of Redisson object that has a timeout
RFuture<Long>	remainTimeToLiveAsync() Remaining time to live of Redisson object that has a timeout
void	setRate(RateType type, long rate, long rateInterval, RateIntervalUnit unit) Updates RateLimiter's state and stores config to Redis server.
RFuture<Void>	setRateAsync(RateType type, long rate, long rateInterval, RateIntervalUnit unit) 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.
RFuture<Boolean>	tryAcquireAsync() Acquires a permit only if one is available at the time of invocation.
RFuture<Boolean>	tryAcquireAsync(long permits) Acquires the given number of permits only if all are available at the time of invocation.
RFuture<Boolean>	tryAcquireAsync(long permits, long timeout, TimeUnit unit) Acquires the given number of permits only if all are available within the given waiting time.
RFuture<Boolean>	tryAcquireAsync(long timeout, TimeUnit unit) Acquires a permit from this RateLimiter, if one becomes available within the given waiting time.
boolean	trySetRate(RateType type, long rate, long rateInterval, RateIntervalUnit unit) Initializes RateLimiter's state and stores config to Redis server.
RFuture<Boolean>	trySetRateAsync(RateType type, long rate, long rateInterval, RateIntervalUnit unit) Initializes RateLimiter's state and stores config to Redis server.

Methods inherited from class org.redisson.RedissonObject

addListener, addListener, addListenerAsync, addListenerAsync, copy, copyAsync, delete, deleteAsync, dump, dumpAsync, encode, encode, encode, encode, encodeMapKey, encodeMapKeys, encodeMapValue, encodeMapValues, get, getCodec, getIdleTime, getIdleTimeAsync, getLockByMapKey, getLockByValue, getName, getRawName, getRawName, isExists, isExistsAsync, migrate, migrateAsync, move, moveAsync, prefixName, removeListener, removeListenerAsync, removeListenersAsync, rename, renameAsync, renamenx, renamenxAsync, restore, restore, restoreAndReplace, restoreAndReplace, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, setName, sizeInMemory, sizeInMemoryAsync, sizeInMemoryAsync, sizeInMemoryAsync, suffixName, toSeconds, toStream, touch, touchAsync, unlink, unlinkAsync

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.redisson.api.RExpirable

clearExpire, expire, expire, expireAt, expireAt, remainTimeToLive

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.RExpirableAsync

expireAsync, expireAtAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObjectAsync

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

Constructor Detail

RedissonRateLimiter

public RedissonRateLimiter(CommandAsyncExecutor commandExecutor,
                           String name)

Method Detail

tryAcquire

public boolean tryAcquire()

Description copied from interface: RRateLimiter

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.

Specified by:

tryAcquire in interface RRateLimiter

Returns:

true if a permit was acquired and false otherwise

tryAcquireAsync

public RFuture<Boolean> tryAcquireAsync()

Description copied from interface: RRateLimiterAsync

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.

Specified by:

tryAcquireAsync in interface RRateLimiterAsync

Returns:

true if a permit was acquired and false otherwise

tryAcquire

public boolean tryAcquire(long permits)

Description copied from interface: RRateLimiter

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.

Specified by:

tryAcquire in interface RRateLimiter

Parameters:

permits - the number of permits to acquire

Returns:

true if a permit was acquired and false otherwise

tryAcquireAsync

public RFuture<Boolean> tryAcquireAsync(long permits)

Description copied from interface: RRateLimiterAsync

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.

Specified by:

tryAcquireAsync in interface RRateLimiterAsync

Parameters:

permits - the number of permits to acquire

Returns:

true if a permit was acquired and false otherwise

acquire

public void acquire()

Description copied from interface: RRateLimiter

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.

Specified by:

acquire in interface RRateLimiter

acquireAsync

public RFuture<Void> acquireAsync()

Description copied from interface: RRateLimiterAsync

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.

Specified by:

acquireAsync in interface RRateLimiterAsync

Returns:

void

acquire

public void acquire(long permits)

Description copied from interface: RRateLimiter

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.

Specified by:

acquire in interface RRateLimiter

Parameters:

permits - the number of permits to acquire

acquireAsync

public RFuture<Void> acquireAsync(long permits)

Description copied from interface: RRateLimiterAsync

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.

Specified by:

acquireAsync in interface RRateLimiterAsync

Parameters:

permits - the number of permits to acquire

Returns:

void

tryAcquire

public boolean tryAcquire(long timeout,
                          TimeUnit unit)

Description copied from interface: RRateLimiter

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.

Specified by:

tryAcquire in interface RRateLimiter

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

tryAcquireAsync

public RFuture<Boolean> tryAcquireAsync(long timeout,
                                        TimeUnit unit)

Description copied from interface: RRateLimiterAsync

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.

Specified by:

tryAcquireAsync in interface RRateLimiterAsync

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

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

Description copied from interface: RRateLimiter

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.

Specified by:

tryAcquire in interface RRateLimiter

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

tryAcquireAsync

public RFuture<Boolean> tryAcquireAsync(long permits,
                                        long timeout,
                                        TimeUnit unit)

Description copied from interface: RRateLimiterAsync

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.

Specified by:

tryAcquireAsync in interface RRateLimiterAsync

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

trySetRate

public boolean trySetRate(RateType type,
                          long rate,
                          long rateInterval,
                          RateIntervalUnit unit)

Description copied from interface: RRateLimiter

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

Specified by:

trySetRate in interface RRateLimiter

Parameters:

type - - rate mode

rate - - rate

rateInterval - - rate time interval

unit - - rate time interval unit

Returns:

true if rate was set and false otherwise

trySetRateAsync

public RFuture<Boolean> trySetRateAsync(RateType type,
                                        long rate,
                                        long rateInterval,
                                        RateIntervalUnit unit)

Description copied from interface: RRateLimiterAsync

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

Specified by:

trySetRateAsync in interface RRateLimiterAsync

Parameters:

type - - rate mode

rate - - rate

rateInterval - - rate time interval

unit - - rate time interval unit

Returns:

true if rate was set and false otherwise

setRate

public void setRate(RateType type,
                    long rate,
                    long rateInterval,
                    RateIntervalUnit unit)

Description copied from interface: RRateLimiter

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

Specified by:

setRate in interface RRateLimiter

Parameters:

type - - rate mode

rate - - rate

rateInterval - - rate time interval

unit - - rate time interval unit

setRateAsync

public RFuture<Void> setRateAsync(RateType type,
                                  long rate,
                                  long rateInterval,
                                  RateIntervalUnit unit)

Description copied from interface: RRateLimiterAsync

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

Specified by:

setRateAsync in interface RRateLimiterAsync

Parameters:

type - - rate mode

rate - - rate

rateInterval - - rate time interval

unit - - rate time interval unit

Returns:

true if rate was set and false otherwise

getConfig

public RateLimiterConfig getConfig()

Description copied from interface: RRateLimiter

Returns current configuration of this RateLimiter object.

Specified by:

getConfig in interface RRateLimiter

Returns:

config object

getConfigAsync

public RFuture<RateLimiterConfig> getConfigAsync()

Description copied from interface: RRateLimiterAsync

Returns current configuration of this RateLimiter object.

Specified by:

getConfigAsync in interface RRateLimiterAsync

Returns:

config object

availablePermits

public long availablePermits()

Description copied from interface: RRateLimiter

Returns amount of available permits.

Specified by:

availablePermits in interface RRateLimiter

Returns:

number of permits

availablePermitsAsync

public RFuture<Long> availablePermitsAsync()

Description copied from interface: RRateLimiterAsync

Returns amount of available permits.

Specified by:

availablePermitsAsync in interface RRateLimiterAsync

Returns:

number of permits

expireAsync

public RFuture<Boolean> expireAsync(long timeToLive,
                                    TimeUnit timeUnit)

Description copied from interface: RExpirableAsync

Set a timeout for object in async mode. After the timeout has expired, the key will automatically be deleted.

Specified by:

expireAsync in interface RExpirableAsync

Parameters:

timeToLive - - timeout before object will be deleted

timeUnit - - timeout time unit

Returns:

true if the timeout was set and false if not

expireAtAsync

public RFuture<Boolean> expireAtAsync(long timestamp)

Description copied from interface: RExpirableAsync

Use RExpirableAsync.expireAsync(Instant) instead

Specified by:

expireAtAsync in interface RExpirableAsync

Parameters:

timestamp - - expire date in milliseconds (Unix timestamp)

Returns:

true if the timeout was set and false if not

clearExpireAsync

public RFuture<Boolean> clearExpireAsync()

Description copied from interface: RExpirableAsync

Clear an expire timeout or expire date for object in async mode. Object will not be deleted.

Specified by:

clearExpireAsync in interface RExpirableAsync

Returns:

true if the timeout was cleared and false if not

deleteAsync

public RFuture<Boolean> deleteAsync()

Description copied from interface: RObjectAsync

Delete object in async mode

Specified by:

deleteAsync in interface RObjectAsync

Overrides:

deleteAsync in class RedissonObject

Returns:

true if object was deleted false if not

expire

public boolean expire(long timeToLive,
                      TimeUnit timeUnit)

Description copied from interface: RExpirable

Set a timeout for object. After the timeout has expired, the key will automatically be deleted.

Specified by:

expire in interface RExpirable

Parameters:

timeToLive - - timeout before object will be deleted

timeUnit - - timeout time unit

Returns:

true if the timeout was set and false if not

expireAt

public boolean expireAt(long timestamp)

Description copied from interface: RExpirable

Use RExpirable.expire(Instant) instead

Specified by:

expireAt in interface RExpirable

Parameters:

timestamp - - expire date in milliseconds (Unix timestamp)

Returns:

true if the timeout was set and false if not

expire

public boolean expire(Instant instant)

Description copied from interface: RExpirable

Set an expire date for object. When expire date comes the key will automatically be deleted.

Specified by:

expire in interface RExpirable

Parameters:

instant - - expire date

Returns:

true if the timeout was set and false if not

expireAsync

public RFuture<Boolean> expireAsync(Instant instant)

Description copied from interface: RExpirableAsync

Set an expire date for object. When expire date comes the key will automatically be deleted.

Specified by:

expireAsync in interface RExpirableAsync

Parameters:

instant - - expire date

Returns:

true if the timeout was set and false if not

expireAt

public boolean expireAt(Date timestamp)

Description copied from interface: RExpirable

Use RExpirable.expire(Instant) instead

Specified by:

expireAt in interface RExpirable

Parameters:

timestamp - - expire date

Returns:

true if the timeout was set and false if not

expireAtAsync

public RFuture<Boolean> expireAtAsync(Date timestamp)

Description copied from interface: RExpirableAsync

Use RExpirableAsync.expireAsync(Instant) instead

Specified by:

expireAtAsync in interface RExpirableAsync

Parameters:

timestamp - - expire date

Returns:

true if the timeout was set and false if not

clearExpire

public boolean clearExpire()

Description copied from interface: RExpirable

Clear an expire timeout or expire date for object.

Specified by:

clearExpire in interface RExpirable

Returns:

true if timeout was removed false if object does not exist or does not have an associated timeout

remainTimeToLive

public long remainTimeToLive()

Description copied from interface: RExpirable

Remaining time to live of Redisson object that has a timeout

Specified by:

remainTimeToLive in interface RExpirable

Returns:

time in milliseconds -2 if the key does not exist. -1 if the key exists but has no associated expire.

remainTimeToLiveAsync

public RFuture<Long> remainTimeToLiveAsync()

Description copied from interface: RExpirableAsync

Remaining time to live of Redisson object that has a timeout

Specified by:

remainTimeToLiveAsync in interface RExpirableAsync

Returns:

time in milliseconds -2 if the key does not exist. -1 if the key exists but has no associated expire.

expireAsync

protected RFuture<Boolean> expireAsync(long timeToLive,
                                       TimeUnit timeUnit,
                                       String... keys)

expireAtAsync

protected RFuture<Boolean> expireAtAsync(long timestamp,
                                         String... keys)

clearExpireAsync

protected RFuture<Boolean> clearExpireAsync(String... keys)