Class RedissonRateLimiter
- java.lang.Object
-
- org.redisson.RedissonObject
-
- org.redisson.RedissonRateLimiter
-
- All Implemented Interfaces:
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
-
-
Constructor Summary
Constructors Constructor Description RedissonRateLimiter(CommandAsyncExecutor commandExecutor, String name)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
acquire()
Acquires a permit from this RateLimiter, blocking until one is available.void
acquire(long permits)
Acquires a specifiedpermits
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 specifiedpermits
from this RateLimiter, blocking until one is available.boolean
tryAcquire()
Acquires a permit only if one is available at the time of invocation.boolean
tryAcquire(long permits)
Acquires the given number ofpermits
only if all are available at the time of invocation.boolean
tryAcquire(long permits, long timeout, TimeUnit unit)
Acquires the given number ofpermits
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 ofpermits
only if all are available at the time of invocation.RFuture<Boolean>
tryAcquireAsync(long permits, long timeout, TimeUnit unit)
Acquires the given number ofpermits
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
await, copy, copyAsync, delete, deleteAsync, dump, dumpAsync, encode, encode, encode, encodeMapKey, encodeMapKeys, encodeMapValue, encodeMapValues, get, getCodec, getName, getName, isExists, isExistsAsync, migrate, migrateAsync, move, moveAsync, prefixName, rename, renameAsync, renamenx, renamenxAsync, restore, restore, restoreAndReplace, restoreAndReplace, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, sizeInMemory, sizeInMemoryAsync, sizeInMemoryAsync, suffixName, toSeconds, 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.RObject
copy, delete, dump, getCodec, getName, isExists, migrate, move, rename, renamenx, restore, restore, restoreAndReplace, restoreAndReplace, sizeInMemory, touch, unlink
-
Methods inherited from interface org.redisson.api.RObjectAsync
copyAsync, deleteAsync, dumpAsync, isExistsAsync, migrateAsync, moveAsync, 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 interfaceRRateLimiter
- Returns:
true
if a permit was acquired andfalse
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 interfaceRRateLimiterAsync
- Returns:
true
if a permit was acquired andfalse
otherwise
-
tryAcquire
public boolean tryAcquire(long permits)
Description copied from interface:RRateLimiter
Acquires the given number ofpermits
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 interfaceRRateLimiter
- Parameters:
permits
- the number of permits to acquire- Returns:
true
if a permit was acquired andfalse
otherwise
-
tryAcquireAsync
public RFuture<Boolean> tryAcquireAsync(long permits)
Description copied from interface:RRateLimiterAsync
Acquires the given number ofpermits
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 interfaceRRateLimiterAsync
- Parameters:
permits
- the number of permits to acquire- Returns:
true
if a permit was acquired andfalse
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 interfaceRRateLimiter
-
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 interfaceRRateLimiterAsync
- Returns:
- void
-
acquire
public void acquire(long permits)
Description copied from interface:RRateLimiter
Acquires a specifiedpermits
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 interfaceRRateLimiter
- Parameters:
permits
- the number of permits to acquire
-
acquireAsync
public RFuture<Void> acquireAsync(long permits)
Description copied from interface:RRateLimiterAsync
Acquires a specifiedpermits
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 interfaceRRateLimiterAsync
- 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 interfaceRRateLimiter
- Parameters:
timeout
- the maximum time to wait for a permitunit
- the time unit of thetimeout
argument- Returns:
true
if a permit was acquired andfalse
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 interfaceRRateLimiterAsync
- Parameters:
timeout
- the maximum time to wait for a permitunit
- the time unit of thetimeout
argument- Returns:
true
if a permit was acquired andfalse
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 ofpermits
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 interfaceRRateLimiter
- Parameters:
permits
- amounttimeout
- the maximum time to wait for a permitunit
- the time unit of thetimeout
argument- Returns:
true
if a permit was acquired andfalse
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 ofpermits
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 interfaceRRateLimiterAsync
- Parameters:
permits
- amounttimeout
- the maximum time to wait for a permitunit
- the time unit of thetimeout
argument- Returns:
true
if a permit was acquired andfalse
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 interfaceRRateLimiter
- Parameters:
type
- - rate moderate
- - raterateInterval
- - rate time intervalunit
- - rate time interval unit- Returns:
true
if rate was set andfalse
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 interfaceRRateLimiterAsync
- Parameters:
type
- - rate moderate
- - raterateInterval
- - rate time intervalunit
- - rate time interval unit- Returns:
true
if rate was set andfalse
otherwise
-
-