org.redisson.api.RLockAsync Maven / Gradle / Ivy
/**
* Copyright 2018 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;
/**
* Distributed implementation of {@link java.util.concurrent.locks.Lock}
*
* @author Nikita Koksharov
*
*/
public interface RLockAsync extends RExpirableAsync {
/**
* Unlocks lock independently of state
*
* @return true if unlocked otherwise false
*/
RFuture forceUnlockAsync();
RFuture unlockAsync();
RFuture unlockAsync(long threadId);
RFuture tryLockAsync();
RFuture lockAsync();
RFuture lockAsync(long threadId);
/**
* Acquires the lock.
*
* If the lock is not available then the current thread becomes
* disabled for thread scheduling purposes and lies dormant until the
* lock has been acquired.
*
* If the lock is acquired, it is held until unlock is invoked,
* or until leaseTime milliseconds have passed
* since the lock was granted - whichever comes first.
*
* @param leaseTime the maximum time to hold the lock after granting it,
* before automatically releasing it 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 of the {@code leaseTime} argument
* @return void
*/
RFuture lockAsync(long leaseTime, TimeUnit unit);
RFuture lockAsync(long leaseTime, TimeUnit unit, long threadId);
RFuture tryLockAsync(long threadId);
RFuture tryLockAsync(long waitTime, TimeUnit unit);
RFuture tryLockAsync(long waitTime, long leaseTime, TimeUnit unit);
RFuture tryLockAsync(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
*/
RFuture getHoldCountAsync();
}