Package org.redisson.api

Interface RExpirableRx

All Superinterfaces:
RObjectRx
All Known Subinterfaces:
RAtomicDoubleRx, RAtomicLongRx, RBinaryStreamRx, RBitSetRx, RBlockingDequeRx<V>, RBlockingQueueRx<V>, RBucketRx<V>, RCollectionRx<V>, RDequeRx<V>, RGeoRx<V>, RHyperLogLogRx<V>, RIdGeneratorRx, RJsonBucketRx<V>, RLexSortedSetRx, RListMultimapCacheRx<K,V>, RListMultimapRx<K,V>, RListRx<V>, RLocalCachedMapRx<K,V>, RMapCacheRx<K,V>, RMapRx<K,V>, RMultimapRx<K,V>, RPermitExpirableSemaphoreRx, RQueueRx<V>, RRateLimiterRx, RReliableTopicRx, RRingBufferRx<V>, RScoredSortedSetRx<V>, RSemaphoreRx, RSetCacheRx<V>, RSetMultimapCacheRx<K,V>, RSetMultimapRx<K,V>, RSetRx<V>, RStreamRx<K,V>, RTimeSeriesRx<V,L>, RTransferQueueRx<V>
public interface RExpirableRx extends RObjectRx
Base interface for all Redisson objects which support expiration or TTL
Author:
Nikita Koksharov

  • Method Details

    • expire

      @Deprecated io.reactivex.rxjava3.core.Single<Boolean> expire(long timeToLive, TimeUnit timeUnit)
      Deprecated.
      Use expire(Duration) instead
      Parameters:
      timeToLive - - timeout before object will be deleted
      timeUnit - - timeout time unit
      Returns:
      true if the timeout was set and false if not

    • expireAt

      @Deprecated io.reactivex.rxjava3.core.Single<Boolean> expireAt(Date timestamp)
      Deprecated.
      Use expire(Instant) instead
      Parameters:
      timestamp - - expire date
      Returns:
      true if the timeout was set and false if not

    • expireAt

      @Deprecated io.reactivex.rxjava3.core.Single<Boolean> expireAt(long timestamp)
      Deprecated.
      Use expire(Instant) instead
      Parameters:
      timestamp - - expire date in milliseconds (Unix timestamp)
      Returns:
      true if the timeout was set and false if not

    • expire

      io.reactivex.rxjava3.core.Single<Boolean> expire(Instant instant)
      Set an expire date for object. When expire date comes the key will automatically be deleted.
      Parameters:
      instant - - expire date
      Returns:
      true if the timeout was set and false if not

    • expireIfSet

      io.reactivex.rxjava3.core.Single<Boolean> expireIfSet(Instant time)
      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.

      Parameters:
      time - expire date
      Returns:
      true if the timeout was set and false if not

    • expireIfNotSet

      io.reactivex.rxjava3.core.Single<Boolean> expireIfNotSet(Instant time)
      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.

      Parameters:
      time - expire date
      Returns:
      true if the timeout was set and false if not

    • expireIfGreater

      io.reactivex.rxjava3.core.Single<Boolean> expireIfGreater(Instant time)
      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.

      Parameters:
      time - expire date
      Returns:
      true if the timeout was set and false if not

    • expireIfLess

      io.reactivex.rxjava3.core.Single<Boolean> expireIfLess(Instant time)
      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.

      Parameters:
      time - expire date
      Returns:
      true if the timeout was set and false if not

    • expire

      io.reactivex.rxjava3.core.Single<Boolean> expire(Duration duration)
      Sets a timeout for this object. After the timeout has expired, the key will automatically be deleted.
      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not

    • expireIfSet

      io.reactivex.rxjava3.core.Single<Boolean> expireIfSet(Duration duration)
      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.

      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not

    • expireIfNotSet

      io.reactivex.rxjava3.core.Single<Boolean> expireIfNotSet(Duration duration)
      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.

      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not

    • expireIfGreater

      io.reactivex.rxjava3.core.Single<Boolean> expireIfGreater(Duration duration)
      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.

      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not

    • expireIfLess

      io.reactivex.rxjava3.core.Single<Boolean> expireIfLess(Duration duration)
      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.

      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not

    • clearExpire

      io.reactivex.rxjava3.core.Single<Boolean> clearExpire()
      Clear an expire timeout or expire date for object in mode. Object will not be deleted.
      Returns:
      true if the timeout was cleared and false if not

    • remainTimeToLive

      io.reactivex.rxjava3.core.Single<Long> remainTimeToLive()
      Get remaining time to live of object in milliseconds.
      Returns:
      time in milliseconds -2 if the key does not exist. -1 if the key exists but has no associated expire.

    • getExpireTime

      io.reactivex.rxjava3.core.Single<Long> getExpireTime()
      Expiration time of Redisson object that has a timeout

      Requires Redis 7.0.0 and higher.

      Returns:
      expiration time