com.github.lontime.shaded.org.redisson.api.RLocalCachedMap Maven / Gradle / Ivy
/**
* 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.Collection;
import java.util.Map;
import java.util.Set;
/**
* Map object with local entry cache support.
*
* Each instance maintains local cache to achieve fast read operations.
* Suitable for maps which used mostly for read operations and network roundtrip delays are undesirable.
*
* @author Nikita Koksharov
*
* @param map key
* @param map value
*/
public interface RLocalCachedMap extends RMap, RDestroyable {
/**
* Pre-warm the cached entries. Not guaranteed to load ALL values, but statistically
* will preload approximately all (all if no concurrent mutating activity).
* Entries are loaded in a batch with size of 10 elements.
*/
void preloadCache();
/**
* Pre-warm the cached entries. Not guaranteed to load ALL values, but statistically
* will preload approximately all (all if no concurrent mutating activity)
* Entries are loaded in a batch. Batch size is defined by count param.
*
* @param count - size of batch
*/
void preloadCache(int count);
/**
* Clears local cache across all instances
*
* @return void
*/
RFuture clearLocalCacheAsync();
/**
* Clears local cache across all instances
*/
void clearLocalCache();
/**
* Returns all keys stored in local cache
*
* @return keys
*/
Set cachedKeySet();
/**
* Returns all values stored in local cache
*
* @return values
*/
Collection cachedValues();
/**
* Returns all map entries stored in local cache
*
* @return entries
*/
Set> cachedEntrySet();
/**
* Returns state of local cache
*
* @return map
*/
Map getCachedMap();
}