com.github.lontime.shaded.org.redisson.api.RSetCacheAsync Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of extredisson-library Show documentation
The newest version!
/**
 * 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 com.github.lontime.shaded.org.redisson.api;

import java.util.Set;
import java.util.concurrent.TimeUnit;

/**
 * Async set functions
 *
 * @author Nikita Koksharov
 *
 * @param  value
 */
public interface RSetCacheAsync extends RCollectionAsync {

    /**
     * Stores value with specified time to live.
     * Value expires after specified time to live.
     *
     * @param value to add
     * @param ttl - time to live for key\value entry.
     *              If 0 then stores infinitely.
     * @param unit - time unit
     * @return true if value has been added. false
     *          if value already been in collection.
     */
    RFuture addAsync(V value, long ttl, TimeUnit unit);

    /**
     * Returns the number of elements in cache.
     * This number can reflects expired elements too
     * due to non realtime cleanup process.
     *
     * @return size of set
     */
    @Override
    RFuture sizeAsync();

    /**
     * Read all elements at once
     *
     * @return values
     */
    RFuture> readAllAsync();

    /**
     * Tries to add elements only if none of them in set.
     *
     * @param values - values to add
     * @return true if elements successfully added,
     *          otherwise false.
     */
    RFuture tryAddAsync(V... values);

    /**
     * Tries to add elements only if none of them in set.
     *
     * @param values - values to add
     * @param ttl - time to live for value.
     *              If 0 then stores infinitely.
     * @param unit - time unit
     * @return true if elements successfully added,
     *          otherwise false.
     */
    RFuture tryAddAsync(long ttl, TimeUnit unit, V... values);

}