org.redisson.api.RLockRx 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.39.0
/**
 * 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 java.util.concurrent.TimeUnit;

import io.reactivex.rxjava3.core.Completable;
import io.reactivex.rxjava3.core.Single;

/**
 * RxJava2 interface for Lock object
 * 
 * @author Nikita Koksharov
 *
 */
public interface RLockRx {

    /**
     * Returns name of object
     *
     * @return name - name of object
     */
    String getName();
    
    /**
     * Unlocks the lock independently of its state
     *
     * @return true if lock existed and now unlocked
     *          otherwise false
     */
    Single forceUnlock();

    /**
     * Unlocks the lock 
     * 
     * @return void
     */
    Completable unlock();

    /**
     * Unlocks the lock. Throws {@link IllegalMonitorStateException} 
     * if lock isn't locked by thread with specified threadId.
     * 
     * @param threadId id of thread
     * @return void
     */
    Completable unlock(long threadId);

    /**
     * Tries to acquire the lock.
     * 
     * @return true if lock acquired otherwise false
     */
    Single tryLock();

    /**
     * Acquires the lock.
     * Waits if necessary until lock became available.
     *
     * @return void
     */
    Completable lock();

    /**
     * Acquires the lock by thread with defined threadId.
     * Waits if necessary until lock became available.
     * 
     * @param threadId id of thread
     * @return void
     */
    Completable lock(long threadId);

    /**
     * Acquires the lock with defined leaseTime.
     * 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 void
     */
    Completable lock(long leaseTime, TimeUnit unit);

    /**
     * Acquires the lock with defined leaseTime and threadId.
     * 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
     * @param threadId id of thread
     * @return void
     */
    Completable lock(long leaseTime, TimeUnit unit, long threadId);

    /**
     * Tries to acquire the lock by thread with specified threadId.
     * 
     * @param threadId id of thread
     * @return true if lock acquired otherwise false
     */
    Single tryLock(long threadId);

    /**
     * Tries to acquire the lock.
     * 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 true if lock is successfully acquired,
     *          otherwise false if lock is already set.
     */
    Single tryLock(long waitTime, TimeUnit unit);

    /**
     * Tries to acquire the lock with defined leaseTime.
     * 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 true if lock is successfully acquired,
     *          otherwise false if lock is already set.
     */
    Single tryLock(long waitTime, long leaseTime, TimeUnit unit);

    /**
     * Tries to acquire the lock by thread with specified threadId and  leaseTime.
     * Waits up to defined waitTime if necessary until the lock became available.
     *
     * Lock will be released automatically after defined leaseTime interval.
     * 
     * @param threadId id of thread
     * @param waitTime time interval to acquire lock
     * @param leaseTime time interval after which lock will be released automatically 
     * @param unit the time unit of the {@code waitTime} and {@code leaseTime} arguments
     * @return true if lock acquired otherwise false
     */
    Single tryLock(long waitTime, long leaseTime, TimeUnit unit, long threadId);

    /**
     * Number of holds on this lock by the current thread
     *
     * @return holds or 0 if this lock is not held by current thread
     */
    Single getHoldCount();
    
    /**
     * Checks if the lock locked by any thread
     *
     * @return true if locked otherwise false
     */
    Single isLocked();

    /**
     * Checks if the lock is held by thread with defined threadId
     *
     * @param threadId Thread ID of locking thread
     * @return true if held by thread with given id
     *          otherwise false
     */
    Single isHeldByThread(long threadId);

    /**
     * Remaining time to live of the lock
     *
     * @return time in milliseconds
     *          -2 if the lock does not exist.
     *          -1 if the lock exists but has no associated expire.
     */
    Single remainTimeToLive();
    
}