com.github.lontime.shaded.org.redisson.api.RSetCache Maven / Gradle / Ivy
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.Iterator;
import java.util.Set;
import java.util.concurrent.TimeUnit;
import java.util.stream.Stream;
import com.github.lontime.shaded.org.redisson.api.mapreduce.RCollectionMapReduce;
/**
* Set-based cache with ability to set TTL for each object.
*
*
* Current Redis implementation doesn't have set entry eviction functionality.
* Thus values are checked for TTL expiration during any value read operation.
* If entry expired then it doesn't returns and clean task runs asynchronous.
* Clean task deletes removes 100 expired entries at once.
* In addition there is {@link com.github.lontime.shaded.org.redisson.eviction.EvictionScheduler}. This scheduler
* deletes expired entries in time interval between 5 seconds to 2 hours.
*
* If eviction is not required then it's better to use {@link com.github.lontime.shaded.org.redisson.api.RSet}.
*
* @author Nikita Koksharov
*
* @param value
*/
public interface RSetCache extends Set, RExpirable, RSetCacheAsync, RDestroyable {
/**
* Returns RCountDownLatch instance associated with value
*
* @param value - set value
* @return RCountDownLatch object
*/
RCountDownLatch getCountDownLatch(V value);
/**
* Returns RPermitExpirableSemaphore instance associated with value
*
* @param value - set value
* @return RPermitExpirableSemaphore object
*/
RPermitExpirableSemaphore getPermitExpirableSemaphore(V value);
/**
* Returns RSemaphore instance associated with value
*
* @param value - set value
* @return RSemaphore object
*/
RSemaphore getSemaphore(V value);
/**
* Returns RLock instance associated with value
*
* @param value - set value
* @return RLock object
*/
RLock getFairLock(V value);
/**
* Returns RReadWriteLock instance associated with value
*
* @param value - set value
* @return RReadWriteLock object
*/
RReadWriteLock getReadWriteLock(V value);
/**
* Returns lock instance associated with value
*
* @param value - set value
* @return RLock object
*/
RLock getLock(V value);
/**
* Returns stream of elements in this set.
* Elements are loaded in batch. Batch size is defined by count param.
*
* @param count - size of elements batch
* @return stream of elements
*/
Stream stream(int count);
/**
* Returns stream of elements in this set.
* Elements are loaded in batch. Batch size is defined by count param.
* If pattern is not null then only elements match this pattern are loaded.
*
* @param pattern - search pattern
* @param count - size of elements batch
* @return stream of elements
*/
Stream stream(String pattern, int count);
/**
* Returns stream of elements in this set matches pattern.
*
* @param pattern - search pattern
* @return stream of elements
*/
Stream stream(String pattern);
/**
* Returns an iterator over elements in this set.
* Elements are loaded in batch. Batch size is defined by count param.
*
* @param count - size of elements batch
* @return iterator
*/
Iterator iterator(int count);
/**
* Returns an iterator over elements in this set.
* Elements are loaded in batch. Batch size is defined by count param.
* If pattern is not null then only elements match this pattern are loaded.
*
* @param pattern - search pattern
* @param count - size of elements batch
* @return iterator
*/
Iterator iterator(String pattern, int count);
/**
* Returns values iterator matches pattern.
*
* @param pattern - search pattern
* @return iterator
*/
Iterator iterator(String pattern);
/**
* Returns RMapReduce object associated with this map
*
* @param output key
* @param output value
* @return MapReduce instance
*/
RCollectionMapReduce mapReduce();
/**
* 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.
*/
boolean add(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
int size();
/**
* Read all elements at once
*
* @return values
*/
Set readAll();
/**
* Tries to add elements only if none of them in set.
*
* @param values - values to add
* @return true if elements successfully added,
* otherwise false.
*/
boolean tryAdd(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.
*/
boolean tryAdd(long ttl, TimeUnit unit, V... values);
}