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 redisson-all Show documentation
Easy Redis Java client and Real-Time Data Platform. Valkey compatible. Sync/Async/RxJava3/Reactive API. Client side caching. Over 50 Redis based Java objects and services: JCache API, Apache Tomcat, Hibernate, Spring, Set, Multimap, SortedSet, Map, List, Queue, Deque, Semaphore, Lock, AtomicLong, Map Reduce, Bloom filter, Scheduler, RPC
There is a newer version: 3.40.2
Show newest version
/**
 * Copyright (c) 2013-2024 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.util.Map;
import java.util.concurrent.TimeUnit;

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

    /**
     * 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();

    /**
     * Use {@link #addIfAbsentAsync(Map)} instead
     *
     * @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.
     */
    @Deprecated
    RFuture tryAddAsync(long ttl, TimeUnit unit, V... values);

    /**
     * Adds element to this set only if has not been added before.
     * 
     * Requires Redis 3.0.2 and higher.
     *
     * @param ttl - object ttl
     * @param object - object itself
     * @return true if element added and false if not.
     */
    RFuture addIfAbsentAsync(Duration ttl, V object);

    /**
     * Adds element to this set only if it's already exists.
     * 

     * Requires Redis 3.0.2 and higher.
     *
     * @param ttl - object ttl
     * @param object - object itself
     * @return true if element added and false if not.
     */
    RFuture addIfExistsAsync(Duration ttl, V object);

    /**
     * Adds element to this set only if new ttl less than current ttl of existed element.
     * 

     * Requires Redis 6.2.0 and higher.
     *
     * @param ttl - object ttl
     * @param object - object itself
     * @return true if element added and false if not.
     */
    RFuture addIfLessAsync(Duration ttl, V object);

    /**
     * Adds element to this set only if new ttl greater than current ttl of existed element.
     * 

     * Requires Redis 6.2.0 and higher.
     *
     * @param ttl - object ttl
     * @param object - object itself
     * @return true if element added and false if not.
     */
    RFuture addIfGreaterAsync(Duration ttl, V object);

    /**
     * Adds all elements contained in the specified map to this sorted set.
     * Map contains of ttl mapped by object.
     *
     * @param objects - map of elements to add
     * @return amount of added elements, not including already existing in this sorted set
     */
    RFuture addAllAsync(Map objects);

    /**
     * Adds elements to this set only if they haven't been added before.
     * 

     * Requires Redis 3.0.2 and higher.
     *
     * @param objects map of elements to add
     * @return amount of added elements
     */
    RFuture addAllIfAbsentAsync(Map objects);
    /**
     * Adds elements to this set only if all of them haven't been added before.
     * 

     * Requires Redis 3.0.2 and higher.
     *
     * @param objects map of elements to add
     * @return amount of added elements
     */
    RFuture addIfAbsentAsync(Map objects);

    /**
     * Adds elements to this set only if they already exist.
     * 

     * Requires Redis 3.0.2 and higher.
     *
     * @param objects map of elements to add
     * @return amount of added elements
     */
    RFuture addAllIfExistAsync(Map objects);

    /**
     * Adds elements to this set only if new ttl greater than current ttl of existed elements.
     * 

     * Requires Redis 6.2.0 and higher.
     *
     * @param objects map of elements to add
     * @return amount of added elements
     */
    RFuture addAllIfGreaterAsync(Map objects);

    /**
     * Adds elements to this set only if new ttl less than current ttl of existed elements.
     * 
     * Requires Redis 6.2.0 and higher.
     *
     * @param objects map of elements to add
     * @return amount of added elements
     */
    RFuture addAllIfLessAsync(Map objects);

    /**
     * Adds object event listener
     *
     * @see org.redisson.api.listener.TrackingListener
     * @see org.redisson.api.listener.SetAddListener
     * @see org.redisson.api.listener.SetRemoveListener
     * @see org.redisson.api.ExpiredObjectListener
     * @see org.redisson.api.DeletedObjectListener
     *
     * @param listener - object event listener
     * @return listener id
     */
    RFuture addListenerAsync(ObjectListener listener);

}