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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of redisson Show documentation

Redis Java client with features of In-Memory Data Grid

There is a newer version: 3.40.2

/**
 * 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 io.reactivex.rxjava3.core.Completable;

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 RLocalCachedMapRx extends RMapRx {

    /**
     * Clears local cache across all instances
     *
     * @return void
     */
    Completable 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();

}