public class RedissonRateLimiter extends RedissonObject implements RRateLimiter
codec, commandExecutor, name
Constructor and Description |
---|
RedissonRateLimiter(CommandAsyncExecutor commandExecutor,
String name) |
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(long timeToLive,
TimeUnit timeUnit)
Set a timeout 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)
Set an expire date for object.
|
boolean |
expireAt(long timestamp)
Set an expire date for object.
|
RFuture<Boolean> |
expireAtAsync(Date timestamp)
Set an expire date for object in async mode.
|
RFuture<Boolean> |
expireAtAsync(long timestamp)
Set an expire date for object in async mode.
|
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
|
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.
|
addListener, addListener, addListenerAsync, addListenerAsync, copy, copyAsync, delete, deleteAsync, dump, dumpAsync, encode, encode, encode, encode, encodeMapKey, encodeMapKeys, encodeMapValue, encodeMapValues, get, getCodec, getLockByMapKey, getLockByValue, getName, getName, isExists, isExistsAsync, migrate, migrateAsync, move, moveAsync, prefixName, removeListener, removeListenerAsync, removeListenersAsync, rename, renameAsync, renamenx, renamenxAsync, restore, restore, restoreAndReplace, restoreAndReplace, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, sizeInMemory, sizeInMemoryAsync, sizeInMemoryAsync, suffixName, toSeconds, toStream, touch, touchAsync, unlink, unlinkAsync
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
clearExpire, expire, expireAt, expireAt, remainTimeToLive
addListener, copy, delete, dump, getCodec, getName, isExists, migrate, move, removeListener, rename, renamenx, restore, restore, restoreAndReplace, restoreAndReplace, sizeInMemory, touch, unlink
clearExpireAsync, expireAsync, expireAtAsync, expireAtAsync, remainTimeToLiveAsync
addListenerAsync, copyAsync, dumpAsync, isExistsAsync, migrateAsync, moveAsync, removeListenerAsync, renameAsync, renamenxAsync, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, sizeInMemoryAsync, touchAsync, unlinkAsync
public RedissonRateLimiter(CommandAsyncExecutor commandExecutor, String name)
public boolean tryAcquire()
RRateLimiter
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
.
tryAcquire
in interface RRateLimiter
true
if a permit was acquired and false
otherwisepublic RFuture<Boolean> tryAcquireAsync()
RRateLimiterAsync
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
.
tryAcquireAsync
in interface RRateLimiterAsync
true
if a permit was acquired and false
otherwisepublic boolean tryAcquire(long permits)
RRateLimiter
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
.
tryAcquire
in interface RRateLimiter
permits
- the number of permits to acquiretrue
if a permit was acquired and false
otherwisepublic RFuture<Boolean> tryAcquireAsync(long permits)
RRateLimiterAsync
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
.
tryAcquireAsync
in interface RRateLimiterAsync
permits
- the number of permits to acquiretrue
if a permit was acquired and false
otherwisepublic void acquire()
RRateLimiter
Acquires a permit, if one is available and returns immediately, reducing the number of available permits by one.
acquire
in interface RRateLimiter
public RFuture<Void> acquireAsync()
RRateLimiterAsync
Acquires a permit, if one is available and returns immediately, reducing the number of available permits by one.
acquireAsync
in interface RRateLimiterAsync
public void acquire(long permits)
RRateLimiter
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.
acquire
in interface RRateLimiter
permits
- the number of permits to acquirepublic RFuture<Void> acquireAsync(long permits)
RRateLimiterAsync
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.
acquireAsync
in interface RRateLimiterAsync
permits
- the number of permits to acquirepublic boolean tryAcquire(long timeout, TimeUnit unit)
RRateLimiter
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.
tryAcquire
in interface RRateLimiter
timeout
- the maximum time to wait for a permitunit
- the time unit of the timeout
argumenttrue
if a permit was acquired and false
if the waiting time elapsed before a permit was acquiredpublic RFuture<Boolean> tryAcquireAsync(long timeout, TimeUnit unit)
RRateLimiterAsync
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.
tryAcquireAsync
in interface RRateLimiterAsync
timeout
- the maximum time to wait for a permitunit
- the time unit of the timeout
argumenttrue
if a permit was acquired and false
if the waiting time elapsed before a permit was acquiredpublic boolean tryAcquire(long permits, long timeout, TimeUnit unit)
RRateLimiter
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.
tryAcquire
in interface RRateLimiter
permits
- amounttimeout
- the maximum time to wait for a permitunit
- the time unit of the timeout
argumenttrue
if a permit was acquired and false
if the waiting time elapsed before a permit was acquiredpublic RFuture<Boolean> tryAcquireAsync(long permits, long timeout, TimeUnit unit)
RRateLimiterAsync
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.
tryAcquireAsync
in interface RRateLimiterAsync
permits
- amounttimeout
- the maximum time to wait for a permitunit
- the time unit of the timeout
argumenttrue
if a permit was acquired and false
if the waiting time elapsed before a permit was acquiredpublic boolean trySetRate(RateType type, long rate, long rateInterval, RateIntervalUnit unit)
RRateLimiter
trySetRate
in interface RRateLimiter
type
- - rate moderate
- - raterateInterval
- - rate time intervalunit
- - rate time interval unittrue
if rate was set and false
otherwisepublic RFuture<Boolean> trySetRateAsync(RateType type, long rate, long rateInterval, RateIntervalUnit unit)
RRateLimiterAsync
trySetRateAsync
in interface RRateLimiterAsync
type
- - rate moderate
- - raterateInterval
- - rate time intervalunit
- - rate time interval unittrue
if rate was set and false
otherwisepublic RateLimiterConfig getConfig()
RRateLimiter
getConfig
in interface RRateLimiter
public RFuture<RateLimiterConfig> getConfigAsync()
RRateLimiterAsync
getConfigAsync
in interface RRateLimiterAsync
public long availablePermits()
RRateLimiter
availablePermits
in interface RRateLimiter
public RFuture<Long> availablePermitsAsync()
RRateLimiterAsync
availablePermitsAsync
in interface RRateLimiterAsync
public RFuture<Boolean> deleteAsync()
RObjectAsync
deleteAsync
in interface RObjectAsync
deleteAsync
in class RedissonObject
true
if object was deleted false
if notpublic boolean expire(long timeToLive, TimeUnit timeUnit)
RExpirable
expire
in interface RExpirable
timeToLive
- - timeout before object will be deletedtimeUnit
- - timeout time unittrue
if the timeout was set and false
if notpublic RFuture<Boolean> expireAsync(long timeToLive, TimeUnit timeUnit)
RExpirableAsync
expireAsync
in interface RExpirableAsync
timeToLive
- - timeout before object will be deletedtimeUnit
- - timeout time unittrue
if the timeout was set and false
if notpublic boolean expireAt(long timestamp)
RExpirable
expireAt
in interface RExpirable
timestamp
- - expire date in milliseconds (Unix timestamp)true
if the timeout was set and false
if notpublic RFuture<Boolean> expireAtAsync(long timestamp)
RExpirableAsync
expireAtAsync
in interface RExpirableAsync
timestamp
- - expire date in milliseconds (Unix timestamp)true
if the timeout was set and false
if notpublic boolean expireAt(Date timestamp)
RExpirable
expireAt
in interface RExpirable
timestamp
- - expire datetrue
if the timeout was set and false
if notpublic RFuture<Boolean> expireAtAsync(Date timestamp)
RExpirableAsync
expireAtAsync
in interface RExpirableAsync
timestamp
- - expire datetrue
if the timeout was set and false
if notpublic boolean clearExpire()
RExpirable
clearExpire
in interface RExpirable
true
if timeout was removed
false
if object does not exist or does not have an associated timeoutpublic RFuture<Boolean> clearExpireAsync()
RExpirableAsync
clearExpireAsync
in interface RExpirableAsync
true
if the timeout was cleared and false
if notpublic long remainTimeToLive()
RExpirable
remainTimeToLive
in interface RExpirable
public RFuture<Long> remainTimeToLiveAsync()
RExpirableAsync
remainTimeToLiveAsync
in interface RExpirableAsync
protected RFuture<Boolean> expireAsync(long timeToLive, TimeUnit timeUnit, String... keys)
Copyright © 2014–2020 Redisson. All rights reserved.