Package org.redisson

Class RedissonRateLimiter

    • Method Detail

      • 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
        Initializes RateLimiter's state and stores config to Redis server.
        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
        Initializes RateLimiter's state and stores config to Redis server.
        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
        Updates RateLimiter's state and stores config to Redis server.
        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
        Updates RateLimiter's state and stores config to Redis server.
        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
      • availablePermits

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

        public RFuture<Boolean> expireAsync(long timeToLive,
                                            TimeUnit timeUnit)
        Description copied from interface: RExpirableAsync
        Set a timeout for object in async mode. After the timeout has expired, the key will automatically be deleted.
        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
      • 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
      • expire

        public boolean expire(long timeToLive,
                              TimeUnit timeUnit)
        Description copied from interface: RExpirable
        Set a timeout for object. After the timeout has expired, the key will automatically be deleted.
        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
      • expireAt

        public boolean expireAt(long timestamp)
        Description copied from interface: RExpirable
        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
      • expire

        public boolean expire(Instant instant)
        Description copied from interface: RExpirable
        Set an expire date for 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
      • 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
      • 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.