Package org.redisson.api

Interface RRateLimiterAsync

All Superinterfaces:
RExpirableAsync, RObjectAsync
All Known Subinterfaces:
RRateLimiter
All Known Implementing Classes:
RedissonRateLimiter
public interface RRateLimiterAsync extends RExpirableAsync
Asynchronous interface for Redis based Rate Limiter object.
Author:
Nikita Koksharov

  • Method Details

    • trySetRateAsync

      RFuture<Boolean> trySetRateAsync(RateType mode, long rate, long rateInterval, RateIntervalUnit rateIntervalUnit)
      Sets the rate limit only if it hasn't been set before.
      Parameters:
      mode - rate mode
      rate - rate
      rateInterval - rate time interval
      rateIntervalUnit - rate time interval unit
      Returns:
      true if rate was set and false otherwise

    • tryAcquireAsync

      RFuture<Boolean> tryAcquireAsync()
      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 and false otherwise

    • tryAcquireAsync

      RFuture<Boolean> tryAcquireAsync(long permits)
      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.

      Parameters:
      permits - the number of permits to acquire
      Returns:
      true if a permit was acquired and false otherwise

    • acquireAsync

      RFuture<Void> acquireAsync()
      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.

      Returns:
      void

    • acquireAsync

      RFuture<Void> acquireAsync(long permits)
      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.

      Parameters:
      permits - the number of permits to acquire
      Returns:
      void

    • tryAcquireAsync

      RFuture<Boolean> tryAcquireAsync(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 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

      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.

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

    • setRateAsync

      RFuture<Void> setRateAsync(RateType mode, long rate, long rateInterval, RateIntervalUnit rateIntervalUnit)
      Sets the rate limit and clears state. Overrides both limit and state if they haven't been set before.
      Parameters:
      mode - rate mode
      rate - rate
      rateInterval - rate time interval
      rateIntervalUnit - rate time interval unit
      Returns:
      true if rate was set and false otherwise

    • getConfigAsync

      RFuture<RateLimiterConfig> getConfigAsync()
      Returns current configuration of this RateLimiter object.
      Returns:
      config object

    • availablePermitsAsync

      RFuture<Long> availablePermitsAsync()
      Returns amount of available permits.
      Returns:
      number of permits