public interface RRateLimiterRx extends RExpirableRx
Modifier and Type | Method and Description |
---|---|
io.reactivex.Completable |
acquire()
Acquires a permit from this RateLimiter, blocking until one is available.
|
io.reactivex.Completable |
acquire(long permits)
Acquires a specified
permits from this RateLimiter,
blocking until one is available. |
io.reactivex.Single<Long> |
availablePermits()
Returns amount of available permits.
|
io.reactivex.Single<Void> |
setRate(RateType mode,
long rate,
long rateInterval,
RateIntervalUnit rateIntervalUnit)
Updates RateLimiter's state and stores config to Redis server.
|
io.reactivex.Single<Boolean> |
tryAcquire()
Acquires a permit only if one is available at the
time of invocation.
|
io.reactivex.Single<Boolean> |
tryAcquire(long permits)
Acquires the given number of
permits only if all are available at the
time of invocation. |
io.reactivex.Single<Boolean> |
tryAcquire(long permits,
long timeout,
TimeUnit unit)
Acquires the given number of
permits only if all are available
within the given waiting time. |
io.reactivex.Single<Boolean> |
tryAcquire(long timeout,
TimeUnit unit)
Acquires a permit from this RateLimiter, if one becomes available
within the given waiting time.
|
io.reactivex.Single<Boolean> |
trySetRate(RateType mode,
long rate,
long rateInterval,
RateIntervalUnit rateIntervalUnit)
Initializes RateLimiter's state and stores config to Redis server.
|
clearExpire, expire, expireAt, expireAt, remainTimeToLive
addListener, copy, delete, dump, getCodec, getIdleTime, getName, isExists, migrate, move, removeListener, rename, renamenx, restore, restore, restoreAndReplace, restoreAndReplace, sizeInMemory, touch, unlink
io.reactivex.Single<Boolean> trySetRate(RateType mode, long rate, long rateInterval, RateIntervalUnit rateIntervalUnit)
mode
- - rate moderate
- - raterateInterval
- - rate time intervalrateIntervalUnit
- - rate time interval unittrue
if rate was set and false
otherwiseio.reactivex.Single<Void> setRate(RateType mode, long rate, long rateInterval, RateIntervalUnit rateIntervalUnit)
mode
- - rate moderate
- - raterateInterval
- - rate time intervalrateIntervalUnit
- - rate time interval unitio.reactivex.Single<Boolean> tryAcquire()
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
.
true
if a permit was acquired and false
otherwiseio.reactivex.Single<Boolean> tryAcquire(long permits)
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
.
permits
- the number of permits to acquiretrue
if a permit was acquired and false
otherwiseio.reactivex.Completable acquire()
Acquires a permit, if one is available and returns immediately, reducing the number of available permits by one.
io.reactivex.Completable acquire(long permits)
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.
permits
- the number of permits to acquireio.reactivex.Single<Boolean> tryAcquire(long timeout, TimeUnit unit)
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.
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 acquiredio.reactivex.Single<Boolean> tryAcquire(long permits, long timeout, TimeUnit unit)
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.
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 acquiredio.reactivex.Single<Long> availablePermits()
Copyright © 2014–2020 Redisson. All rights reserved.