Package org.redisson.api

Interface RPermitExpirableSemaphoreReactive

All Superinterfaces:
RExpirableReactive, RObjectReactive
public interface RPermitExpirableSemaphoreReactive extends RExpirableReactive
Reactive interface for Semaphore object with lease time parameter support for each acquired permit.

Each permit identified by own id and could be released only using its id. Permit id is a 128-bits unique random identifier generated each time during acquiring.

Works in non-fair mode. Therefore order of acquiring is unpredictable.

Author:
Nikita Koksharov

  • Method Details

    • acquire

      reactor.core.publisher.Mono<String> acquire()
      Acquires a permit and returns its id. Waits if necessary until a permit became available.
      Returns:
      permit id

    • acquire

      reactor.core.publisher.Mono<List<String>> acquire(int permits)
      Acquires defined amount of permits. Waits if necessary until all permits became available.
      Parameters:
      permits - the number of permits to acquire
      Returns:
      permits ids

    • acquire

      reactor.core.publisher.Mono<String> acquire(long leaseTime, TimeUnit unit)
      Acquires a permit with defined leaseTime and return its id. Waits if necessary until a permit became available.
      Parameters:
      leaseTime - permit lease time
      unit - time unit
      Returns:
      permit id

    • acquire

      reactor.core.publisher.Mono<List<String>> acquire(int permits, long leaseTime, TimeUnit unit)
      Acquires defined amount of permits with defined leaseTime and returns ids. Waits if necessary until all permits became available.
      Parameters:
      permits - the number of permits to acquire
      leaseTime - permits lease time
      unit - time unit
      Returns:
      permits ids

    • tryAcquire

      reactor.core.publisher.Mono<String> tryAcquire()
      Tries to acquire currently available permit and return its id.
      Returns:
      permit id if a permit was acquired and null otherwise

    • tryAcquire

      reactor.core.publisher.Mono<List<String>> tryAcquire(int permits)
      Tries to acquire defined amount of currently available permits and returns ids.
      Parameters:
      permits - the number of permits to acquire
      Returns:
      permits ids if permits were acquired and empty collection otherwise

    • tryAcquire

      reactor.core.publisher.Mono<String> tryAcquire(long waitTime, TimeUnit unit)
      Tries to acquire currently available permit and return its id. Waits up to defined waitTime if necessary until a permit became available.
      Parameters:
      waitTime - the maximum time to wait
      unit - the time unit
      Returns:
      permit id if a permit was acquired and null if the waiting time elapsed before a permit was acquired

    • tryAcquire

      reactor.core.publisher.Mono<String> tryAcquire(long waitTime, long leaseTime, TimeUnit unit)
      Tries to acquire currently available permit with defined leaseTime and return its id. Waits up to defined waitTime if necessary until a permit became available.
      Parameters:
      waitTime - the maximum time to wait
      leaseTime - permit lease time, use -1 to make it permanent
      unit - the time unit
      Returns:
      permit id if a permit was acquired and null if the waiting time elapsed before a permit was acquired

    • tryAcquire

      reactor.core.publisher.Mono<List<String>> tryAcquire(int permits, long waitTime, long leaseTime, TimeUnit unit)
      Tries to acquire defined amount of currently available permits with defined leaseTime and return their ids. Waits up to defined waitTime if necessary until enough permits became available.
      Parameters:
      permits - the number of permits to acquire
      waitTime - the maximum time to wait
      leaseTime - permits lease time, use -1 to make them permanent
      unit - the time unit
      Returns:
      permits ids if permits were acquired and empty collection if the waiting time elapsed before permits were acquired

    • tryRelease

      reactor.core.publisher.Mono<Boolean> tryRelease(String permitId)
      Tries to release permit by its id.
      Parameters:
      permitId - permit id
      Returns:
      true if a permit has been released and false otherwise

    • tryRelease

      reactor.core.publisher.Mono<Integer> tryRelease(List<String> permitsIds)
      Tries to release permits by their ids.
      Parameters:
      permitsIds - permits ids
      Returns:
      amount of released permits

    • release

      reactor.core.publisher.Mono<Void> release(String permitId)
      Releases a permit by its id. Increases the number of available permits. Throws an exception if permit id doesn't exist or has already been released.
      Parameters:
      permitId - - permit id
      Returns:
      void

    • release

      reactor.core.publisher.Mono<Void> release(List<String> permitsIds)
      Releases a permits by their ids. Increases the number of available permits. Throws an exception if permit id doesn't exist or has already been released.
      Parameters:
      permitsIds - - permits ids
      Returns:
      void

    • availablePermits

      reactor.core.publisher.Mono<Integer> availablePermits()
      Returns amount of available permits.
      Returns:
      number of permits

    • getPermits

      reactor.core.publisher.Mono<Integer> getPermits()
      Returns the number of permits.
      Returns:
      number of permits

    • acquiredPermits

      reactor.core.publisher.Mono<Integer> acquiredPermits()
      Returns the number of acquired permits.
      Returns:
      number of acquired permits

    • trySetPermits

      reactor.core.publisher.Mono<Boolean> trySetPermits(int permits)
      Tries to set number of permits.
      Parameters:
      permits - - number of permits
      Returns:
      true if permits has been set successfully, otherwise false.

    • setPermits

      reactor.core.publisher.Mono<Void> setPermits(int permits)
      Sets the number of permits to the provided value. Calculates the delta between the given permits value and the current number of permits, then increases the number of available permits by delta.
      Parameters:
      permits - - number of permits

    • addPermits

      reactor.core.publisher.Mono<Void> addPermits(int permits)
      Increases or decreases the number of available permits by defined value.
      Parameters:
      permits - amount of permits to add/remove
      Returns:
      void

    • updateLeaseTime

      reactor.core.publisher.Mono<Boolean> updateLeaseTime(String permitId, long leaseTime, TimeUnit unit)
      Overrides and updates lease time for defined permit id.
      Parameters:
      permitId - permit id
      leaseTime - permit lease time, use -1 to make it permanent
      unit - the time unit
      Returns:
      true if permits has been updated successfully, otherwise false.