org.redisson.api.RFencedLockReactive 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

The 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;

import reactor.core.publisher.Mono;

import java.util.concurrent.TimeUnit;

/**
 * Redis based implementation of Fenced Lock with reentrancy support.
 * 
 * Each lock acquisition increases fencing token. It should be
 * checked if it's greater or equal with the previous one by
 * the service guarded by this lock and reject operation if condition is false.
 *
 * @author Nikita Koksharov
 *
 */
public interface RFencedLockReactive extends RLockReactive {

    /**
     * Returns current fencing token
     *
     * @return fencing token
     */
    Mono getToken();

    /**
     * Acquires the lock and returns increased fencing token.
     * Waits if necessary until lock became available.
     *
     * @return fencing token
     */
    Mono lockAndGetToken();

    /**
     * Acquires the lock with defined leaseTime and
     * returns increased fencing token.
     * Waits if necessary until lock became available.
     * 

     * Lock will be released automatically after defined leaseTime interval.
     *
     * @param leaseTime the maximum time to hold the lock after it's acquisition,
     *        if it hasn't already been released by invoking unlock.
     *        If leaseTime is -1, hold the lock until explicitly unlocked.
     * @param unit the time unit
     *
     * @return fencing token
     */
    Mono lockAndGetToken(long leaseTime, TimeUnit unit);

    /**
     * Tries to acquire the lock and returns increased fencing token if operation successful.
     *
     * @return fencing token if lock acquired otherwise null
     */
    Mono tryLockAndGetToken();

    /**
     * Tries to acquire the lock and returns increased fencing token.
     * Waits up to defined waitTime if necessary until the lock became available.
     *
     * @param waitTime the maximum time to acquire the lock
     * @param unit time unit
     * @return fencing token if lock is successfully acquired,
     *          otherwise null if lock is already set.
     */
    Mono tryLockAndGetToken(long waitTime, TimeUnit unit);

    /**
     * Tries to acquire the lock with defined leaseTime
     * and returns increased fencing token.
     * Waits up to defined waitTime if necessary until the lock became available.
     * 
     * Lock will be released automatically after defined leaseTime interval.
     *
     * @param waitTime the maximum time to acquire the lock
     * @param leaseTime lease time
     * @param unit time unit
     * @return fencing token if lock is successfully acquired,
     *          otherwise null if lock is already set.
     */
    Mono tryLockAndGetToken(long waitTime, long leaseTime, TimeUnit unit);

}