Package org.redisson

Class RedissonRateLimiter

java.lang.Object
org.redisson.RedissonObject
org.redisson.RedissonRateLimiter
All Implemented Interfaces:
RExpirable, RExpirableAsync, RObject, RObjectAsync, RRateLimiter, RRateLimiterAsync
public class RedissonRateLimiter extends RedissonObject implements RRateLimiter
Author:
Nikita Koksharov

  • Constructor Details

  • Method Details

    • 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 interface RRateLimiter
      Returns:
      true if a permit was acquired and false 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 interface RRateLimiterAsync
      Returns:
      true if a permit was acquired and false otherwise

    • tryAcquire

      public boolean tryAcquire(long permits)
      Description copied from interface: RRateLimiter
      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.

      Specified by:
      tryAcquire in interface RRateLimiter
      Parameters:
      permits - the number of permits to acquire
      Returns:
      true if a permit was acquired and false otherwise

    • tryAcquireAsync

      public RFuture<Boolean> tryAcquireAsync(long permits)
      Description copied from interface: RRateLimiterAsync
      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.

      Specified by:
      tryAcquireAsync in interface RRateLimiterAsync
      Parameters:
      permits - the number of permits to acquire
      Returns:
      true if a permit was acquired and false 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 interface RRateLimiter

    • 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 interface RRateLimiterAsync
      Returns:
      void

    • acquire

      public void acquire(long permits)
      Description copied from interface: RRateLimiter
      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.

      Specified by:
      acquire in interface RRateLimiter
      Parameters:
      permits - the number of permits to acquire

    • acquireAsync

      public RFuture<Void> acquireAsync(long permits)
      Description copied from interface: RRateLimiterAsync
      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.

      Specified by:
      acquireAsync in interface RRateLimiterAsync
      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 interface RRateLimiter
      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

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

    • tryAcquire

      public boolean tryAcquire(long permits, long timeout, TimeUnit unit)
      Description copied from interface: RRateLimiter
      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.

      Specified by:
      tryAcquire in interface RRateLimiter
      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

    • tryAcquireAsync

      public RFuture<Boolean> tryAcquireAsync(long permits, long timeout, TimeUnit unit)
      Description copied from interface: RRateLimiterAsync
      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.

      Specified by:
      tryAcquireAsync in interface RRateLimiterAsync
      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

    • trySetRate

      public boolean trySetRate(RateType type, long rate, long rateInterval, RateIntervalUnit unit)
      Description copied from interface: RRateLimiter
      Sets the rate limit only if it hasn't been set before.
      Specified by:
      trySetRate in interface RRateLimiter
      Parameters:
      type - rate mode
      rate - rate
      rateInterval - rate time interval
      unit - rate time interval unit
      Returns:
      true if rate was set and false otherwise

    • trySetRateAsync

      public RFuture<Boolean> trySetRateAsync(RateType type, long rate, long rateInterval, RateIntervalUnit unit)
      Description copied from interface: RRateLimiterAsync
      Sets the rate limit only if it hasn't been set before.
      Specified by:
      trySetRateAsync in interface RRateLimiterAsync
      Parameters:
      type - rate mode
      rate - rate
      rateInterval - rate time interval
      unit - rate time interval unit
      Returns:
      true if rate was set and false otherwise

    • setRate

      public void setRate(RateType type, long rate, long rateInterval, RateIntervalUnit unit)
      Description copied from interface: RRateLimiter
      Sets the rate limit and clears state. Overrides both limit and state if they haven't been set before.
      Specified by:
      setRate in interface RRateLimiter
      Parameters:
      type - rate mode
      rate - rate
      rateInterval - rate time interval
      unit - rate time interval unit

    • setRateAsync

      public RFuture<Void> setRateAsync(RateType type, long rate, long rateInterval, RateIntervalUnit unit)
      Description copied from interface: RRateLimiterAsync
      Sets the rate limit and clears state. Overrides both limit and state if they haven't been set before.
      Specified by:
      setRateAsync in interface RRateLimiterAsync
      Parameters:
      type - rate mode
      rate - rate
      rateInterval - rate time interval
      unit - rate time interval unit
      Returns:
      true if rate was set and false otherwise

    • getConfig

      public RateLimiterConfig getConfig()
      Description copied from interface: RRateLimiter
      Returns current configuration of this RateLimiter object.
      Specified by:
      getConfig in interface RRateLimiter
      Returns:
      config object

    • getConfigAsync

      public RFuture<RateLimiterConfig> getConfigAsync()
      Description copied from interface: RRateLimiterAsync
      Returns current configuration of this RateLimiter object.
      Specified by:
      getConfigAsync in interface RRateLimiterAsync
      Returns:
      config object

    • availablePermits

      public long availablePermits()
      Description copied from interface: RRateLimiter
      Returns amount of available permits.
      Specified by:
      availablePermits in interface RRateLimiter
      Returns:
      number of permits

    • availablePermitsAsync

      public RFuture<Long> availablePermitsAsync()
      Description copied from interface: RRateLimiterAsync
      Returns amount of available permits.
      Specified by:
      availablePermitsAsync in interface RRateLimiterAsync
      Returns:
      number of permits

    • expireAsync

      public RFuture<Boolean> expireAsync(long timeToLive, TimeUnit timeUnit, String param, String... keys)

    • expireAtAsync

      protected RFuture<Boolean> expireAtAsync(long timestamp, String param, String... keys)

    • clearExpireAsync

      public RFuture<Boolean> clearExpireAsync()
      Description copied from interface: RExpirableAsync
      Clear an expire timeout or expire date for object in async mode. Object will not be deleted.
      Specified by:
      clearExpireAsync in interface RExpirableAsync
      Returns:
      true if the timeout was cleared and false if not

    • deleteAsync

      public RFuture<Boolean> deleteAsync()
      Description copied from interface: RObjectAsync
      Delete object in async mode
      Specified by:
      deleteAsync in interface RObjectAsync
      Overrides:
      deleteAsync in class RedissonObject
      Returns:
      true if object was deleted false if not

    • expire

      public boolean expire(long timeToLive, TimeUnit timeUnit)
      Description copied from interface: RExpirable
      Use RExpirable.expire(Duration) instead
      Specified by:
      expire in interface RExpirable
      Parameters:
      timeToLive - - timeout before object will be deleted
      timeUnit - - timeout time unit
      Returns:
      true if the timeout was set and false if not

    • expireAsync

      public RFuture<Boolean> expireAsync(long timeToLive, TimeUnit timeUnit)
      Description copied from interface: RExpirableAsync
      Use RExpirableAsync.expireAsync(Duration) instead
      Specified by:
      expireAsync in interface RExpirableAsync
      Parameters:
      timeToLive - - timeout before object will be deleted
      timeUnit - - timeout time unit
      Returns:
      true if the timeout was set and false if not

    • expireAt

      public boolean expireAt(long timestamp)
      Description copied from interface: RExpirable
      Use RExpirable.expire(Instant) instead
      Specified by:
      expireAt in interface RExpirable
      Parameters:
      timestamp - - expire date in milliseconds (Unix timestamp)
      Returns:
      true if the timeout was set and false if not

    • expireAtAsync

      public RFuture<Boolean> expireAtAsync(long timestamp)
      Description copied from interface: RExpirableAsync
      Use RExpirableAsync.expireAsync(Instant) instead
      Specified by:
      expireAtAsync in interface RExpirableAsync
      Parameters:
      timestamp - - expire date in milliseconds (Unix timestamp)
      Returns:
      true if the timeout was set and false if not

    • expire

      public boolean expire(Instant instant)
      Description copied from interface: RExpirable
      Sets an expiration date for this object. When expire date comes the key will automatically be deleted.
      Specified by:
      expire in interface RExpirable
      Parameters:
      instant - expire date
      Returns:
      true if the timeout was set and false if not

    • expireIfSet

      public boolean expireIfSet(Instant time)
      Description copied from interface: RExpirable
      Sets an expiration date for this object only if it has been already set. When expire date comes the object will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfSet in interface RExpirable
      Parameters:
      time - expire date
      Returns:
      true if the timeout was set and false if not

    • expireIfSetAsync

      public RFuture<Boolean> expireIfSetAsync(Instant time)
      Description copied from interface: RExpirableAsync
      Sets an expiration date for this object only if it has been already set. When expire date comes the object will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfSetAsync in interface RExpirableAsync
      Parameters:
      time - expire date
      Returns:
      true if the timeout was set and false if not

    • expireIfNotSet

      public boolean expireIfNotSet(Instant time)
      Description copied from interface: RExpirable
      Sets an expiration date for this object only if it hasn't been set before. When expire date comes the object will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfNotSet in interface RExpirable
      Parameters:
      time - expire date
      Returns:
      true if the timeout was set and false if not

    • expireIfNotSetAsync

      public RFuture<Boolean> expireIfNotSetAsync(Instant time)
      Description copied from interface: RExpirableAsync
      Sets an expiration date for this object only if it hasn't been set before. When expire date comes the object will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfNotSetAsync in interface RExpirableAsync
      Parameters:
      time - expire date
      Returns:
      true if the timeout was set and false if not

    • expireIfGreater

      public boolean expireIfGreater(Instant time)
      Description copied from interface: RExpirable
      Sets an expiration date for this object only if it's greater than expiration date set before. When expire date comes the object will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfGreater in interface RExpirable
      Parameters:
      time - expire date
      Returns:
      true if the timeout was set and false if not

    • expireIfGreaterAsync

      public RFuture<Boolean> expireIfGreaterAsync(Instant time)
      Description copied from interface: RExpirableAsync
      Sets an expiration date for this object only if it's greater than expiration date set before. When expire date comes the object will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfGreaterAsync in interface RExpirableAsync
      Parameters:
      time - expire date
      Returns:
      true if the timeout was set and false if not

    • expireIfLess

      public boolean expireIfLess(Instant time)
      Description copied from interface: RExpirable
      Sets an expiration date for this object only if it's less than expiration date set before. When expire date comes the object will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfLess in interface RExpirable
      Parameters:
      time - expire date
      Returns:
      true if the timeout was set and false if not

    • expireIfLessAsync

      public RFuture<Boolean> expireIfLessAsync(Instant time)
      Description copied from interface: RExpirableAsync
      Sets an expiration date for this object only if it's less than expiration date set before. When expire date comes the object will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfLessAsync in interface RExpirableAsync
      Parameters:
      time - expire date
      Returns:
      true if the timeout was set and false if not

    • expireAsync

      public RFuture<Boolean> expireAsync(Instant instant)
      Description copied from interface: RExpirableAsync
      Set an expire date for object. When expire date comes the key will automatically be deleted.
      Specified by:
      expireAsync in interface RExpirableAsync
      Parameters:
      instant - - expire date
      Returns:
      true if the timeout was set and false if not

    • expire

      public boolean expire(Duration duration)
      Description copied from interface: RExpirable
      Sets a timeout for this object. After the timeout has expired, the key will automatically be deleted.
      Specified by:
      expire in interface RExpirable
      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not

    • expireAsync

      public RFuture<Boolean> expireAsync(Duration duration)
      Description copied from interface: RExpirableAsync
      Set a timeout for object. After the timeout has expired, the key will automatically be deleted.
      Specified by:
      expireAsync in interface RExpirableAsync
      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not

    • expireAt

      public boolean expireAt(Date timestamp)
      Description copied from interface: RExpirable
      Use RExpirable.expire(Instant) instead
      Specified by:
      expireAt in interface RExpirable
      Parameters:
      timestamp - - expire date
      Returns:
      true if the timeout was set and false if not

    • expireAtAsync

      public RFuture<Boolean> expireAtAsync(Date timestamp)
      Description copied from interface: RExpirableAsync
      Use RExpirableAsync.expireAsync(Instant) instead
      Specified by:
      expireAtAsync in interface RExpirableAsync
      Parameters:
      timestamp - - expire date
      Returns:
      true if the timeout was set and false if not

    • expireIfSet

      public boolean expireIfSet(Duration duration)
      Description copied from interface: RExpirable
      Sets a timeout for this object only if it has been already set. After the timeout has expired, the key will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfSet in interface RExpirable
      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not

    • expireIfSetAsync

      public RFuture<Boolean> expireIfSetAsync(Duration duration)
      Description copied from interface: RExpirableAsync
      Sets a timeout for this object only if it has been already set. After the timeout has expired, the key will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfSetAsync in interface RExpirableAsync
      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not

    • expireIfNotSet

      public boolean expireIfNotSet(Duration duration)
      Description copied from interface: RExpirable
      Sets a timeout for this object only if it hasn't been set before. After the timeout has expired, the key will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfNotSet in interface RExpirable
      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not

    • expireIfNotSetAsync

      public RFuture<Boolean> expireIfNotSetAsync(Duration duration)
      Description copied from interface: RExpirableAsync
      Sets a timeout for this object only if it hasn't been set before. After the timeout has expired, the key will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfNotSetAsync in interface RExpirableAsync
      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not

    • expireIfGreater

      public boolean expireIfGreater(Duration duration)
      Description copied from interface: RExpirable
      Sets a timeout for this object only if it's greater than timeout set before. After the timeout has expired, the key will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfGreater in interface RExpirable
      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not

    • expireIfGreaterAsync

      public RFuture<Boolean> expireIfGreaterAsync(Duration duration)
      Description copied from interface: RExpirableAsync
      Sets a timeout for this object only if it's greater than timeout set before. After the timeout has expired, the key will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfGreaterAsync in interface RExpirableAsync
      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not

    • expireIfLess

      public boolean expireIfLess(Duration duration)
      Description copied from interface: RExpirable
      Sets a timeout for this object only if it's less than timeout set before. After the timeout has expired, the key will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfLess in interface RExpirable
      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not

    • expireIfLessAsync

      public RFuture<Boolean> expireIfLessAsync(Duration duration)
      Description copied from interface: RExpirableAsync
      Sets a timeout for this object only if it's less than timeout set before. After the timeout has expired, the key will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfLessAsync in interface RExpirableAsync
      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not

    • clearExpire

      public boolean clearExpire()
      Description copied from interface: RExpirable
      Clear an expire timeout or expire date for object.
      Specified by:
      clearExpire in interface RExpirable
      Returns:
      true if timeout was removed false if object does not exist or does not have an associated timeout

    • remainTimeToLive

      public long remainTimeToLive()
      Description copied from interface: RExpirable
      Remaining time to live of Redisson object that has a timeout
      Specified by:
      remainTimeToLive in interface RExpirable
      Returns:
      time in milliseconds -2 if the key does not exist. -1 if the key exists but has no associated expire.

    • remainTimeToLiveAsync

      public RFuture<Long> remainTimeToLiveAsync()
      Description copied from interface: RExpirableAsync
      Remaining time to live of Redisson object that has a timeout
      Specified by:
      remainTimeToLiveAsync in interface RExpirableAsync
      Returns:
      time in milliseconds -2 if the key does not exist. -1 if the key exists but has no associated expire.

    • getExpireTime

      public long getExpireTime()
      Description copied from interface: RExpirable
      Expiration time of Redisson object that has a timeout

      Requires Redis 7.0.0 and higher.

      Specified by:
      getExpireTime in interface RExpirable
      Returns:
      expiration time

    • getExpireTimeAsync

      public RFuture<Long> getExpireTimeAsync()
      Description copied from interface: RExpirableAsync
      Expiration time of Redisson object that has a timeout

      Requires Redis 7.0.0 and higher.

      Specified by:
      getExpireTimeAsync in interface RExpirableAsync
      Returns:
      expiration time

    • clearExpireAsync

      protected RFuture<Boolean> clearExpireAsync(String... keys)