org.redisson.api.options.ExMapOptions 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.options;

import org.redisson.api.map.*;
import org.redisson.client.codec.Codec;

import java.time.Duration;

/**
 *
 * @author Nikita Koksharov
 *
 * @param  returned object type
 * @param  type of key
 * @param  type of value
 */
public interface ExMapOptions, K, V> extends CodecOptions {

    /**
     * Defines {@link MapWriter} object which is invoked during write operation.
     *
     * @param writer object
     * @return MapOptions instance
     */
    T writer(MapWriter writer);

    /**
     * Defines {@link MapWriterAsync} object which is invoked during write operation.
     *
     * @param writer object
     * @return MapOptions instance
     */
    T writerAsync(MapWriterAsync writer);
    /**
     * Sets write behind tasks batch size.
     * All updates accumulated into a batch of specified size and written with {@link MapWriter}.
     * 
     * Default is 50
     *
     * @param writeBehindBatchSize size of batch
     * @return MapOptions instance
     */
    T writeBehindBatchSize(int writeBehindBatchSize);

    /**
     * Sets write behind tasks execution delay.
     * All updates written with {@link MapWriter} and lag not more than specified delay.
     * 

     * Default is 1000 milliseconds
     *
     * @param writeBehindDelay delay in milliseconds
     * @return MapOptions instance
     */
    T writeBehindDelay(int writeBehindDelay);

    /**
     * Sets write mode.
     * 
     * Default is {@link WriteMode#WRITE_THROUGH}
     *
     * @param writeMode write mode
     * @return MapOptions instance
     */
    T writeMode(WriteMode writeMode);

    /**
     * Sets max write retry attempts
     *
     * @param writerRetryAttempts object
     * @return MapOptions instance
     */
    T writeRetryAttempts(int writerRetryAttempts);

    /**
     * Sets write retry interval
     *
     * @param writerRetryInterval {@link Duration}
     * @return MapOptions instance
     */
    T writeRetryInterval(Duration writerRetryInterval);

    /**
     * Sets {@link MapLoader} object.
     *
     * @param loader object
     * @return MapOptions instance
     */
    T loader(MapLoader loader);

    /**
     * Sets {@link MapLoaderAsync} object.
     *
     * @param loaderAsync object
     * @return MapOptions instance
     */
    T loaderAsync(MapLoaderAsync loaderAsync);

}