Interface RRateLimiterRx

  • All Superinterfaces:
    RExpirableRx, RObjectRx

    public interface RRateLimiterRx
    extends RExpirableRx
    Reactive interface for Redis based Rate Limiter object.
    Author:
    Nikita Koksharov
    • Method Detail

      • trySetRate

        io.reactivex.rxjava3.core.Single<Boolean> trySetRate​(RateType mode,
                                                             long rate,
                                                             long rateInterval,
                                                             RateIntervalUnit rateIntervalUnit)
        Initializes RateLimiter's state and stores config to Redis server.
        Parameters:
        mode - - rate mode
        rate - - rate
        rateInterval - - rate time interval
        rateIntervalUnit - - rate time interval unit
        Returns:
        true if rate was set and false otherwise
      • setRate

        io.reactivex.rxjava3.core.Single<Void> setRate​(RateType mode,
                                                       long rate,
                                                       long rateInterval,
                                                       RateIntervalUnit rateIntervalUnit)
        Updates RateLimiter's state and stores config to Redis server.
        Parameters:
        mode - - rate mode
        rate - - rate
        rateInterval - - rate time interval
        rateIntervalUnit - - rate time interval unit
      • tryAcquire

        io.reactivex.rxjava3.core.Single<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 and false otherwise
      • tryAcquire

        io.reactivex.rxjava3.core.Single<Boolean> tryAcquire​(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
      • acquire

        io.reactivex.rxjava3.core.Completable 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.

        Returns:
        void
      • acquire

        io.reactivex.rxjava3.core.Completable acquire​(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
      • tryAcquire

        io.reactivex.rxjava3.core.Single<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 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

        io.reactivex.rxjava3.core.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.

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

        io.reactivex.rxjava3.core.Single<Long> availablePermits()
        Returns amount of available permits.
        Returns:
        number of permits