org.redisson.api.RExpirableAsync Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of redisson-all Show documentation
Redis based In-Memory Data Grid for Java
There is a newer version: 3.36.0
/**
 * Copyright (c) 2013-2021 Nikita Koksharov
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.redisson.api;

import java.time.Duration;
import java.time.Instant;
import java.util.Date;
import java.util.concurrent.TimeUnit;

/**
 * Base async interface for all Redisson objects
 * which supports expiration (TTL)
 *
 * @author Nikita Koksharov
 *
 */
public interface RExpirableAsync extends RObjectAsync {

    /**
     * Use {@link #expireAsync(Duration)} instead
     *
     * @param timeToLive - timeout before object will be deleted
     * @param timeUnit - timeout time unit
     * @return true if the timeout was set and false if not
     */
    @Deprecated
    RFuture expireAsync(long timeToLive, TimeUnit timeUnit);

    /**
     * Use {@link #expireAsync(Instant)} instead
     *
     * @param timestamp - expire date
     * @return true if the timeout was set and false if not
     */
    @Deprecated
    RFuture expireAtAsync(Date timestamp);

    /**
     * Use {@link #expireAsync(Instant)} instead
     *
     * @param timestamp - expire date in milliseconds (Unix timestamp)
     * @return true if the timeout was set and false if not
     */
    @Deprecated
    RFuture expireAtAsync(long timestamp);

    /**
     * Set an expire date for object. When expire date comes
     * the key will automatically be deleted.
     *
     * @param time - expire date
     * @return true if the timeout was set and false if not
     */
    RFuture expireAsync(Instant time);

    RFuture expireIfSetAsync(Instant time);

    RFuture expireIfNotSetAsync(Instant time);

    RFuture expireIfGreaterAsync(Instant time);

    RFuture expireIfLessAsync(Instant time);

    /**
     * Set a timeout for object. After the timeout has expired,
     * the key will automatically be deleted.
     *
     * @param duration timeout before object will be deleted
     * @return true if the timeout was set and false if not
     */
    RFuture expireAsync(Duration duration);

    RFuture expireIfSetAsync(Duration duration);

    RFuture expireIfNotSetAsync(Duration duration);

    RFuture expireIfGreaterAsync(Duration duration);

    RFuture expireIfLessAsync(Duration duration);

    /**
     * Clear an expire timeout or expire date for object in async mode.
     * Object will not be deleted.
     *
     * @return true if the timeout was cleared and false if not
     */
    RFuture clearExpireAsync();

    /**
     * Remaining time to live of Redisson object that has a timeout 
     *
     * @return time in milliseconds
     *          -2 if the key does not exist.
     *          -1 if the key exists but has no associated expire.
     */
    RFuture remainTimeToLiveAsync();

    /**
     * Expiration time of Redisson object that has a timeout
     * 
     * Requires Redis 7.0.0 and higher.
     *
     * @return expiration time
     */
    RFuture getExpireTimeAsync();

}