org.redisson.api.options.InvocationOptions 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 java.time.Duration;

/**
 *
 * @author Nikita Koksharov
 *
 */
public interface InvocationOptions> {

    /**
     * Defines Redis server response timeout. Starts to countdown
     * when a Redis command was successfully sent.
     * 
     * Default is the value specified for the same parameter in Redisson configuration
     *
     * @param timeout Redis server response timeout
     * @return options instance
     */
    T timeout(Duration timeout);

    /**
     * Defines command retry attempts. Error is thrown if
     * the Redis command can't be sent to Redis server after retryAttempts.
     * But if it sent successfully then responseTimeout is started.
     * 
     * Default is the value specified for the same parameter in Redisson configuration
     *
     * @param retryAttempts command retry attempts
     * @return options instance
     */
    T retryAttempts(int retryAttempts);

    /**
     * Defines time interval for another one attempt to send a Redis command
     * if it hasn't already been sent.
     *
     * @param interval retry time interval
     * @return options instance
     */
    T retryInterval(Duration interval);

}