Package org.redisson

Class RedissonPermitExpirableSemaphore

java.lang.Object
org.redisson.RedissonObject
org.redisson.RedissonPermitExpirableSemaphore
All Implemented Interfaces:
RExpirable, RExpirableAsync, RObject, RObjectAsync, RPermitExpirableSemaphore, RPermitExpirableSemaphoreAsync

public class RedissonPermitExpirableSemaphore extends RedissonObject implements RPermitExpirableSemaphore
Author:
Nikita Koksharov
  • Constructor Details

  • Method Details

    • acquire

      public String acquire() throws InterruptedException
      Description copied from interface: RPermitExpirableSemaphore
      Acquires a permit and returns its id. Waits if necessary until a permit became available.
      Specified by:
      acquire in interface RPermitExpirableSemaphore
      Returns:
      permit id
      Throws:
      InterruptedException - if the current thread is interrupted
    • acquire

      public List<String> acquire(int permits) throws InterruptedException
      Description copied from interface: RPermitExpirableSemaphore
      Acquires defined amount of permits. Waits if necessary until enough permits became available.
      Specified by:
      acquire in interface RPermitExpirableSemaphore
      Parameters:
      permits - the number of permits to acquire
      Returns:
      permits ids
      Throws:
      InterruptedException - if the current thread is interrupted
    • acquire

      public String acquire(long leaseTime, TimeUnit timeUnit) throws InterruptedException
      Description copied from interface: RPermitExpirableSemaphore
      Acquires a permit with defined leaseTime and return its id. Waits if necessary until a permit became available.
      Specified by:
      acquire in interface RPermitExpirableSemaphore
      Parameters:
      leaseTime - permit lease time
      timeUnit - time unit
      Returns:
      permit id
      Throws:
      InterruptedException - if the current thread is interrupted
    • acquire

      public List<String> acquire(int permits, long leaseTime, TimeUnit timeUnit) throws InterruptedException
      Description copied from interface: RPermitExpirableSemaphore
      Acquires defined amount of permits with defined leaseTime and returns ids. Waits if necessary until enough permits became available.
      Specified by:
      acquire in interface RPermitExpirableSemaphore
      Parameters:
      permits - the number of permits to acquire
      leaseTime - permit lease time
      timeUnit - time unit
      Returns:
      permits ids
      Throws:
      InterruptedException - if the current thread is interrupted
    • acquireAsync

      public RFuture<String> acquireAsync()
      Description copied from interface: RPermitExpirableSemaphoreAsync
      Acquires a permit and returns its id. Waits if necessary until a permit became available.
      Specified by:
      acquireAsync in interface RPermitExpirableSemaphoreAsync
      Returns:
      permit id
    • acquireAsync

      public RFuture<List<String>> acquireAsync(int permits)
      Description copied from interface: RPermitExpirableSemaphoreAsync
      Acquires defined amount of permits and returns their ids. Waits if necessary until all permits became available.
      Specified by:
      acquireAsync in interface RPermitExpirableSemaphoreAsync
      Parameters:
      permits - the number of permits to acquire
      Returns:
      permits ids
    • acquireAsync

      public RFuture<String> acquireAsync(long leaseTime, TimeUnit timeUnit)
      Description copied from interface: RPermitExpirableSemaphoreAsync
      Acquires a permit with defined leaseTime and return its id. Waits if necessary until a permit became available.
      Specified by:
      acquireAsync in interface RPermitExpirableSemaphoreAsync
      Parameters:
      leaseTime - permit lease time
      timeUnit - time unit
      Returns:
      permit id
    • acquireAsync

      public RFuture<List<String>> acquireAsync(int permits, long leaseTime, TimeUnit timeUnit)
      Description copied from interface: RPermitExpirableSemaphoreAsync
      Acquires defined amount of permits and return their ids. Waits if necessary until all permits became available.
      Specified by:
      acquireAsync in interface RPermitExpirableSemaphoreAsync
      Parameters:
      permits - the number of permits to acquire
      leaseTime - permit lease time
      timeUnit - time unit
      Returns:
      permits ids
    • tryAcquire

      public String tryAcquire()
      Description copied from interface: RPermitExpirableSemaphore
      Tries to acquire currently available permit and return its id.
      Specified by:
      tryAcquire in interface RPermitExpirableSemaphore
      Returns:
      permit id if a permit was acquired and null otherwise
    • tryAcquire

      public List<String> tryAcquire(int permits)
      Description copied from interface: RPermitExpirableSemaphore
      Tries to acquire defined amount of currently available permits and returns ids.
      Specified by:
      tryAcquire in interface RPermitExpirableSemaphore
      Parameters:
      permits - the number of permits to acquire
      Returns:
      permits ids if permits were acquired and empty collection otherwise
    • tryAcquireAsync

      public RFuture<String> tryAcquireAsync()
      Description copied from interface: RPermitExpirableSemaphoreAsync
      Tries to acquire currently available permit and return its id.
      Specified by:
      tryAcquireAsync in interface RPermitExpirableSemaphoreAsync
      Returns:
      permit id if a permit was acquired and null otherwise
    • tryAcquireAsync

      public RFuture<List<String>> tryAcquireAsync(int permits)
      Description copied from interface: RPermitExpirableSemaphoreAsync
      Tries to acquire defined amount of currently available permits and returns their ids.
      Specified by:
      tryAcquireAsync in interface RPermitExpirableSemaphoreAsync
      Parameters:
      permits - the number of permits to acquire
      Returns:
      permits ids if permits were acquired and empty list otherwise
    • tryAcquireAsync

      public RFuture<String> tryAcquireAsync(long waitTime, TimeUnit unit)
      Description copied from interface: RPermitExpirableSemaphoreAsync
      Tries to acquire currently available permit and return its id. Waits up to defined waitTime if necessary until a permit became available.
      Specified by:
      tryAcquireAsync in interface RPermitExpirableSemaphoreAsync
      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

      public String tryAcquire(long waitTime, long leaseTime, TimeUnit unit) throws InterruptedException
      Description copied from interface: RPermitExpirableSemaphore
      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.
      Specified by:
      tryAcquire in interface RPermitExpirableSemaphore
      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
      Throws:
      InterruptedException - if the current thread is interrupted
    • tryAcquireAsync

      public RFuture<String> tryAcquireAsync(long waitTime, long leaseTime, TimeUnit unit)
      Description copied from interface: RPermitExpirableSemaphoreAsync
      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.
      Specified by:
      tryAcquireAsync in interface RPermitExpirableSemaphoreAsync
      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

      public List<String> tryAcquire(int permits, long waitTime, long leaseTime, TimeUnit unit) throws InterruptedException
      Description copied from interface: RPermitExpirableSemaphore
      Tries to acquire defined amount of currently available permits with defined leaseTime and return ids. Waits up to defined waitTime if necessary until enough permits became available.
      Specified by:
      tryAcquire in interface RPermitExpirableSemaphore
      Parameters:
      permits - the number of permits to acquire
      waitTime - the maximum time to wait
      leaseTime - permit lease time, use -1 to make it permanent
      unit - the time unit
      Returns:
      permits ids if permits were acquired and empty collection if the waiting time elapsed before permits were acquired
      Throws:
      InterruptedException - if the current thread is interrupted
    • tryAcquireAsync

      public RFuture<List<String>> tryAcquireAsync(int permits, long waitTime, long leaseTime, TimeUnit timeUnit)
      Description copied from interface: RPermitExpirableSemaphoreAsync
      Tries to acquire defined amount of currently available permits with defined leaseTime and returns their ids. Waits up to defined waitTime if necessary until permits became available.
      Specified by:
      tryAcquireAsync in interface RPermitExpirableSemaphoreAsync
      Parameters:
      permits - the number of permits to acquire
      waitTime - the maximum time to wait
      leaseTime - permit lease time, use -1 to make it permanent
      timeUnit - the time unit
      Returns:
      permits ids if permits were acquired and empty list if the waiting time elapsed before permit were acquired
    • tryAcquire

      public String tryAcquire(long waitTime, TimeUnit unit) throws InterruptedException
      Description copied from interface: RPermitExpirableSemaphore
      Tries to acquire currently available permit and return its id. Waits up to defined waitTime if necessary until a permit became available.
      Specified by:
      tryAcquire in interface RPermitExpirableSemaphore
      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
      Throws:
      InterruptedException - if the current thread is interrupted
    • release

      public void release(String permitId)
      Description copied from interface: RPermitExpirableSemaphore
      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.
      Specified by:
      release in interface RPermitExpirableSemaphore
      Parameters:
      permitId - - permit id
    • release

      public void release(List<String> permitsIds)
      Description copied from interface: RPermitExpirableSemaphore
      Releases permits by their ids. Increases the number of available permits. Throws an exception if permit id doesn't exist or has already been released.
      Specified by:
      release in interface RPermitExpirableSemaphore
      Parameters:
      permitsIds - - permits ids
    • tryRelease

      public boolean tryRelease(String permitId)
      Description copied from interface: RPermitExpirableSemaphore
      Tries to release permit by its id.
      Specified by:
      tryRelease in interface RPermitExpirableSemaphore
      Parameters:
      permitId - permit id
      Returns:
      true if a permit has been released and false otherwise
    • tryRelease

      public int tryRelease(List<String> permitsIds)
      Description copied from interface: RPermitExpirableSemaphore
      Tries to release permits by their ids.
      Specified by:
      tryRelease in interface RPermitExpirableSemaphore
      Parameters:
      permitsIds - - permits ids
      Returns:
      amount of released permits
    • tryReleaseAsync

      public RFuture<Boolean> tryReleaseAsync(String permitId)
      Description copied from interface: RPermitExpirableSemaphoreAsync
      Tries to release permit by its id.
      Specified by:
      tryReleaseAsync in interface RPermitExpirableSemaphoreAsync
      Parameters:
      permitId - permit id
      Returns:
      true if a permit has been released and false otherwise
    • tryReleaseAsync

      public RFuture<Integer> tryReleaseAsync(List<String> permitsIds)
      Description copied from interface: RPermitExpirableSemaphoreAsync
      Tries to release defined permits by their ids.
      Specified by:
      tryReleaseAsync in interface RPermitExpirableSemaphoreAsync
      Parameters:
      permitsIds - - permits ids
      Returns:
      amount of released permits
    • sizeInMemoryAsync

      public RFuture<Long> sizeInMemoryAsync()
      Description copied from interface: RObjectAsync
      Returns bytes amount used by object in Redis memory.
      Specified by:
      sizeInMemoryAsync in interface RObjectAsync
      Overrides:
      sizeInMemoryAsync in class RedissonObject
      Returns:
      size in bytes
    • 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
    • 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
    • releaseAsync

      public RFuture<Void> releaseAsync(String permitId)
      Description copied from interface: RPermitExpirableSemaphoreAsync
      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.
      Specified by:
      releaseAsync in interface RPermitExpirableSemaphoreAsync
      Parameters:
      permitId - - permit id
      Returns:
      void
    • releaseAsync

      public RFuture<Void> releaseAsync(List<String> permitsIds)
      Description copied from interface: RPermitExpirableSemaphoreAsync
      Releases permits by their ids. Increases the number of available permits. Throws an exception if permits ids don't exist or have already been released.
      Specified by:
      releaseAsync in interface RPermitExpirableSemaphoreAsync
      Parameters:
      permitsIds - - permit id
    • availablePermits

      public int availablePermits()
      Description copied from interface: RPermitExpirableSemaphore
      Returns number of available permits.
      Specified by:
      availablePermits in interface RPermitExpirableSemaphore
      Returns:
      number of available permits
    • getPermits

      public int getPermits()
      Description copied from interface: RPermitExpirableSemaphore
      Returns the number of permits.
      Specified by:
      getPermits in interface RPermitExpirableSemaphore
      Returns:
      number of permits
    • acquiredPermits

      public int acquiredPermits()
      Description copied from interface: RPermitExpirableSemaphore
      Returns the number of acquired permits.
      Specified by:
      acquiredPermits in interface RPermitExpirableSemaphore
      Returns:
      number of acquired permits
    • availablePermitsAsync

      public RFuture<Integer> availablePermitsAsync()
      Description copied from interface: RPermitExpirableSemaphoreAsync
      Returns number of available permits.
      Specified by:
      availablePermitsAsync in interface RPermitExpirableSemaphoreAsync
      Returns:
      number of permits
    • getPermitsAsync

      public RFuture<Integer> getPermitsAsync()
      Description copied from interface: RPermitExpirableSemaphoreAsync
      Returns the number of permits.
      Specified by:
      getPermitsAsync in interface RPermitExpirableSemaphoreAsync
      Returns:
      number of permits
    • acquiredPermitsAsync

      public RFuture<Integer> acquiredPermitsAsync()
      Description copied from interface: RPermitExpirableSemaphoreAsync
      Returns the number of acquired permits.
      Specified by:
      acquiredPermitsAsync in interface RPermitExpirableSemaphoreAsync
      Returns:
      number of acquired permits
    • trySetPermits

      public boolean trySetPermits(int permits)
      Description copied from interface: RPermitExpirableSemaphore
      Tries to set the initial number of available permits.
      Specified by:
      trySetPermits in interface RPermitExpirableSemaphore
      Parameters:
      permits - - number of permits
      Returns:
      true if permits has been set successfully, otherwise false.
    • setPermits

      public void setPermits(int permits)
      Description copied from interface: RPermitExpirableSemaphore
      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.
      Specified by:
      setPermits in interface RPermitExpirableSemaphore
      Parameters:
      permits - - number of permits
    • setPermitsAsync

      public RFuture<Void> setPermitsAsync(int permits)
      Description copied from interface: RPermitExpirableSemaphoreAsync
      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.
      Specified by:
      setPermitsAsync in interface RPermitExpirableSemaphoreAsync
      Parameters:
      permits - - number of permits
    • trySetPermitsAsync

      public RFuture<Boolean> trySetPermitsAsync(int permits)
      Description copied from interface: RPermitExpirableSemaphoreAsync
      Tries to set number of available permits.
      Specified by:
      trySetPermitsAsync in interface RPermitExpirableSemaphoreAsync
      Parameters:
      permits - - number of permits
      Returns:
      true if permits has been set successfully, otherwise false.
    • addPermits

      public void addPermits(int permits)
      Description copied from interface: RPermitExpirableSemaphore
      Increases or decreases the number of available permits by defined value.
      Specified by:
      addPermits in interface RPermitExpirableSemaphore
      Parameters:
      permits - amount of permits to add/remove
    • addPermitsAsync

      public RFuture<Void> addPermitsAsync(int permits)
      Description copied from interface: RPermitExpirableSemaphoreAsync
      Increases or decreases the number of available permits by defined value.
      Specified by:
      addPermitsAsync in interface RPermitExpirableSemaphoreAsync
      Parameters:
      permits - amount of permits to add/remove
      Returns:
      void
    • updateLeaseTimeAsync

      public RFuture<Boolean> updateLeaseTimeAsync(String permitId, long leaseTime, TimeUnit unit)
      Description copied from interface: RPermitExpirableSemaphoreAsync
      Overrides and updates lease time for defined permit id.
      Specified by:
      updateLeaseTimeAsync in interface RPermitExpirableSemaphoreAsync
      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.
    • updateLeaseTime

      public boolean updateLeaseTime(String permitId, long leaseTime, TimeUnit unit)
      Description copied from interface: RPermitExpirableSemaphore
      Overrides and updates lease time for defined permit id.
      Specified by:
      updateLeaseTime in interface RPermitExpirableSemaphore
      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.
    • expire

      public boolean expire(long timeToLive, TimeUnit timeUnit)
      Description copied from interface: RExpirable
      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
      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
      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
      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
      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
      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)