com.mongodb.internal.Locks Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mongodb-driver-core Show documentation
Show all versions of mongodb-driver-core Show documentation
The Java operations layer for the MongoDB Java Driver.
Third parties can wrap this layer to provide custom higher-level APIs
/*
* Copyright 2008-present MongoDB, Inc.
*
* 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 com.mongodb.internal;
import com.mongodb.MongoInterruptedException;
import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReentrantLock;
import java.util.function.Supplier;
import static com.mongodb.internal.thread.InterruptionUtil.interruptAndCreateMongoInterruptedException;
/**
* This class is not part of the public API and may be removed or changed at any time
*/
public final class Locks {
public static void withLock(final Lock lock, final Runnable action) {
withLock(lock, () -> {
action.run();
return null;
});
}
public static V withLock(final Lock lock, final Supplier supplier) {
return checkedWithLock(lock, supplier::get);
}
public static V checkedWithLock(final Lock lock, final CheckedSupplier supplier) throws E {
lock.lock();
try {
return supplier.get();
} finally {
lock.unlock();
}
}
public static void withInterruptibleLock(final Lock lock, final Runnable action) throws MongoInterruptedException {
withInterruptibleLock(lock, () -> {
action.run();
return null;
});
}
public static V withInterruptibleLock(final Lock lock, final Supplier supplier) throws MongoInterruptedException {
return checkedWithInterruptibleLock(lock, supplier::get);
}
public static V checkedWithInterruptibleLock(final Lock lock, final CheckedSupplier supplier)
throws MongoInterruptedException, E {
lockInterruptibly(lock);
try {
return supplier.get();
} finally {
lock.unlock();
}
}
public static void lockInterruptibly(final Lock lock) throws MongoInterruptedException {
try {
lock.lockInterruptibly();
} catch (InterruptedException e) {
throw interruptAndCreateMongoInterruptedException("Interrupted waiting for lock", e);
}
}
/**
* See {@link #lockInterruptiblyUnfair(ReentrantLock)} before using this method.
*/
public static void withUnfairLock(final ReentrantLock lock, final Runnable action) {
withUnfairLock(lock, () -> {
action.run();
return null;
});
}
/**
* See {@link #lockInterruptiblyUnfair(ReentrantLock)} before using this method.
*/
public static V withUnfairLock(final ReentrantLock lock, final Supplier supplier) {
lockUnfair(lock);
try {
return supplier.get();
} finally {
lock.unlock();
}
}
private static void lockUnfair(
// The type must be `ReentrantLock`, not `Lock`,
// because only `ReentrantLock.tryLock` is documented to have the barging (unfair) behavior.
final ReentrantLock lock) {
if (!lock.tryLock()) {
lock.lock();
}
}
/**
* This method allows a thread to attempt acquiring the {@code lock} unfairly despite the {@code lock}
* being {@linkplain ReentrantLock#ReentrantLock(boolean) fair}. In most cases you should create an unfair lock,
* instead of using this method.
*/
public static void lockInterruptiblyUnfair(
// The type must be `ReentrantLock`, not `Lock`,
// because only `ReentrantLock.tryLock` is documented to have the barging (unfair) behavior.
final ReentrantLock lock) throws MongoInterruptedException {
if (Thread.currentThread().isInterrupted()) {
throw interruptAndCreateMongoInterruptedException(null, null);
}
if (!lock.tryLock()) {
lockInterruptibly(lock);
}
}
private Locks() {
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy