Interface RRateLimiterReactive
-
- All Superinterfaces:
RObjectReactive
public interface RRateLimiterReactive extends RObjectReactive
- Author:
- Nikita Koksharov
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description org.reactivestreams.Publisher<Void>
acquire()
Acquires a permit from this RateLimiter, blocking until one is available.org.reactivestreams.Publisher<Void>
acquire(long permits)
Acquires a specifiedpermits
from this RateLimiter, blocking until one is available.org.reactivestreams.Publisher<Boolean>
tryAcquire()
Acquires a permit only if one is available at the time of invocation.org.reactivestreams.Publisher<Boolean>
tryAcquire(long permits)
Acquires the given number ofpermits
only if all are available at the time of invocation.org.reactivestreams.Publisher<Boolean>
tryAcquire(long permits, long timeout, TimeUnit unit)
Acquires the given number ofpermits
only if all are available within the given waiting time.org.reactivestreams.Publisher<Boolean>
tryAcquire(long timeout, TimeUnit unit)
Acquires a permit from this RateLimiter, if one becomes available within the given waiting time.org.reactivestreams.Publisher<Boolean>
trySetRate(RateType mode, long rate, long rateInterval, RateIntervalUnit rateIntervalUnit)
Initializes RateLimiter's state and stores config to Redis server.
-
-
-
Method Detail
-
trySetRate
org.reactivestreams.Publisher<Boolean> trySetRate(RateType mode, long rate, long rateInterval, RateIntervalUnit rateIntervalUnit)
Initializes RateLimiter's state and stores config to Redis server.- Parameters:
mode
- - rate moderate
- - raterateInterval
- - rate time intervalrateIntervalUnit
- - rate time interval unit- Returns:
-
tryAcquire
org.reactivestreams.Publisher<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 andfalse
otherwise
-
tryAcquire
org.reactivestreams.Publisher<Boolean> tryAcquire(long permits)
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
.- Parameters:
permits
- the number of permits to acquire- Returns:
true
if a permit was acquired andfalse
otherwise
-
acquire
org.reactivestreams.Publisher<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
org.reactivestreams.Publisher<Void> acquire(long permits)
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.
- Parameters:
permits
-
-
tryAcquire
org.reactivestreams.Publisher<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 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
org.reactivestreams.Publisher<Boolean> tryAcquire(long permits, long timeout, TimeUnit unit)
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.- 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
-
-