Класс StampedLock
- Все реализуемые интерфейсы:
Serializable
public class StampedLock extends Object implements Serializable
-
Запись. Метод
writeLock()возможно блокируется в ожидании эксклюзивного доступа, возвращая штамп, который может быть использован в методеunlockWrite(long)для освобождения блокировки. Также предоставляются неуправляемые и управляемые по времени версииtryWriteLock. Когда блокировка удерживается в режиме записи, не могут быть получены блокировки чтения, и все оптимистичные проверки чтения завершатся неудачей. -
Чтение. Метод
readLock()возможно блокируется в ожидании неэксклюзивного доступа, возвращая штамп, который может быть использован в методеunlockRead(long)для освобождения блокировки. Также предоставляются неуправляемые и управляемые по времени версииtryReadLock. -
Оптимистическое чтение. Метод
tryOptimisticRead()возвращает ненулевой штамп только в том случае, если блокировка в настоящее время не удерживается в режиме записи. Методvalidate(long)возвращает true, если блокировка не была приобретена в режиме записи с момента получения данного штампа, в этом случае все действия до последнего освобождения блокировки записи происходят до действий, следующих за вызовомtryOptimisticRead. Этот режим можно рассматривать как чрезвычайно слабую версию блокировки чтения, которая может быть прервана записывающим потоком в любое время. Использование режима оптимистического чтения для коротких участков кода только для чтения часто снижает конфликтность и повышает пропускную способность. Однако его использование по своей природе хрупкое. Участки кода оптимистического чтения должны только считывать поля и удерживать их в локальных переменных для последующего использования после проверки. Поля, прочитанные в режиме оптимистического чтения, могут быть сильно несовместимы, поэтому использование применяется только тогда, когда вы достаточно знакомы с представлениями данных, чтобы проверить согласованность и/или многократно вызывать методvalidate(). Например, такие шаги обычно требуются при первом чтении ссылки на объект или массив, а затем доступе к одному из его полей, элементов или методов.
Этот класс также поддерживает методы, которые условно обеспечивают преобразования между тремя режимами. Например, метод tryConvertToWriteLock(long) пытается "обновить" режим, возвращая действительный штамп записи, если (1) уже в режиме записи (2) в режиме чтения и нет других читателей или (3) в режиме оптимистического чтения и блокировка доступна. Формы этих методов предназначены для уменьшения некоторого надувания кода, которое в противном случае происходит в проектах, основанных на повторных попытках.
StampedLocks разработаны для использования в качестве внутренних утилит при разработке потокобезопасных компонентов. Их использование основано на знаниях внутренних свойств данных, объектов и методов, которые они защищают. Они не являются реентерабельными, поэтому заблокированные тела не должны вызывать другие неизвестные методы, которые могут пытаться повторно приобрести блокировки (хотя вы можете передать штамп другим методам, которые могут использовать или преобразовывать его). Использование режимов блокировки чтения основано на том, что соответствующие разделы кода не имеют побочных эффектов. Невалидированные участки оптимистического чтения не могут вызывать методы, которые не известны, чтобы они могли терпеть потенциальные несогласованности. Штампы используют конечные представления и не являются криптографически защищенными (т.е., действительный штамп может быть угадан). Значения штампов могут циклически повторно использоваться после (не ранее) одного года непрерывной работы. Штамп, удерживаемый без использования или проверки в течение более длительного периода, может не пройти проверку правильно. StampedLocks сериализуемы, но всегда десериализуются в первоначальное разблокированное состояние, поэтому они не подходят для удаленного блокирования.
Подобно Semaphore, но в отличие от большинства реализаций Lock, StampedLocks не имеют понятия владения. Блокировки, приобретенные в одном потоке, могут быть освобождены или преобразованы в другом.
Политика планирования StampedLock не последовательно отдаёт предпочтение читателям над писателями или наоборот. Все методы "попытки" являются наилучшими усилиями и не обязательно соответствуют какой-либо политике планирования или справедливости. Возвращение нуля от любого метода "попытки" для приобретения или преобразования блокировок не несёт никакой информации о состоянии блокировки; последующий вызов может быть успешным.
Поскольку он поддерживает скоординированное использование в нескольких режимах блокировки, этот класс напрямую не реализует интерфейсы Lock или ReadWriteLock. Однако, StampedLock может быть рассмотрен asReadLock(), asWriteLock() или asReadWriteLock() в приложениях, требующих только соответствующего набора функциональности.
Синхронизация памяти. Методы, имеющие эффект успешного блокирования в любом режиме, имеют те же эффекты синхронизации памяти, что и действие Lock, как описано в главе 17 спецификации языка Java. Методы успешного разблокирования в режиме записи имеют те же эффекты синхронизации памяти, что и действие Unlock. При использовании оптимистического чтения действия до последнего действия разблокировки в режиме записи гарантированно происходят до действий, следующих за tryOptimisticRead, только если последующая проверка возвращает true; в противном случае нет гарантии, что чтения между tryOptimisticRead и validate получат согласованную моментальную фотографию.
Пример использования. Ниже приведён пример использования в классе, который поддерживает простые двухмерные точки. Пример кода демонстрирует некоторые соглашения try/catch, хотя они здесь строго не нужны, потому что исключения не могут возникнуть в их телах.
class Point {
private double x, y;
private final StampedLock sl = new StampedLock();
// an exclusively locked method
void move(double deltaX, double deltaY) {
long stamp = sl.writeLock();
try {
x += deltaX;
y += deltaY;
} finally {
sl.unlockWrite(stamp);
}
}
// a read-only method
// upgrade from optimistic read to read lock
double distanceFromOrigin() {
long stamp = sl.tryOptimisticRead();
try {
retryHoldingLock: for (;; stamp = sl.readLock()) {
if (stamp == 0L)
continue retryHoldingLock;
// possibly racy reads
double currentX = x;
double currentY = y;
if (!sl.validate(stamp))
continue retryHoldingLock;
return Math.hypot(currentX, currentY);
}
} finally {
if (StampedLock.isReadLockStamp(stamp))
sl.unlockRead(stamp);
}
}
// upgrade from optimistic read to write lock
void moveIfAtOrigin(double newX, double newY) {
long stamp = sl.tryOptimisticRead();
try {
retryHoldingLock: for (;; stamp = sl.writeLock()) {
if (stamp == 0L)
continue retryHoldingLock;
// possibly racy reads
double currentX = x;
double currentY = y;
if (!sl.validate(stamp))
continue retryHoldingLock;
if (currentX != 0.0 || currentY != 0.0)
break;
stamp = sl.tryConvertToWriteLock(stamp);
if (stamp == 0L)
continue retryHoldingLock;
// exclusive access
x = newX;
y = newY;
return;
}
} finally {
if (StampedLock.isWriteLockStamp(stamp))
sl.unlockWrite(stamp);
}
}
// upgrade read lock to write lock
void moveIfAtOrigin2(double newX, double newY) {
long stamp = sl.readLock();
try {
while (x == 0.0 && y == 0.0) {
long ws = sl.tryConvertToWriteLock(stamp);
if (ws != 0L) {
stamp = ws;
x = newX;
y = newY;
break;
}
else {
sl.unlockRead(stamp);
stamp = sl.writeLock();
}
}
} finally {
sl.unlock(stamp);
}
}
}
- См. Спецификацию языка Java:
- 17.4 Модель памяти
- С:
- 1.8
- См. также:
Краткое описание конструкторов
| Конструктор | Описание |
|---|---|
StampedLock() |
Создаёт новый замок, изначально в разблокированном состоянии. |
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
Lock |
asReadLock() |
Возвращает простой Lock вид этого StampedLock, в котором метод Lock.lock() сопоставлен с readLock(), и аналогично для других методов. |
ReadWriteLock |
asReadWriteLock() |
Возвращает ReadWriteLock вид этого StampedLock, в котором метод ReadWriteLock.readLock() сопоставлен с asReadLock(), а ReadWriteLock.writeLock() с asWriteLock(). |
Lock |
asWriteLock() |
Возвращает простой Lock вид этого StampedLock, в котором метод Lock.lock() сопоставлен с writeLock(), и аналогично для других методов. |
int |
getReadLockCount() |
Опрашивает количество захваченных чтений для этого замка. |
static boolean |
isLockStamp |
Указывает, представляет ли штамп удержание замка. |
static boolean |
isOptimisticReadStamp |
Указывает, представляет ли штамп успешное оптимистическое чтение. |
boolean |
isReadLocked() |
Возвращает true, если замок в настоящее время удерживается неисключительно. |
static boolean |
isReadLockStamp |
Указывает, представляет ли штамп удержание замка неисключительно. |
boolean |
isWriteLocked() |
Возвращает true, если замок в настоящее время удерживается исключительно. |
static boolean |
isWriteLockStamp |
Указывает, представляет ли штамп удержание замка исключительно. |
long |
readLock() |
Неисключительно приобретает замок, блокируя, если необходимо, до тех пор, пока он не станет доступным. |
long |
readLockInterruptibly() |
Неисключительно приобретает замок, блокируя, если необходимо, до тех пор, пока он не станет доступным или текущий поток не будет прерван. |
String |
toString() |
Возвращает строку, идентифицирующую этот замок, а также его состояние. |
long |
tryConvertToOptimisticRead |
Если состояние замка соответствует заданному штампу, то атомарно, если штамп представляет собой удержание замка, освобождает его и возвращает наблюдаемый штамп. |
long |
tryConvertToReadLock |
Если состояние замка соответствует заданному штампу, атомарно выполняет одно из следующих действий. |
long |
tryConvertToWriteLock |
Если состояние замка соответствует заданному штампу, атомарно выполняет одно из следующих действий. |
long |
tryOptimisticRead() |
Возвращает штамп, который позже можно проверить, или ноль, если замок заблокирован исключительно. |
long |
tryReadLock() |
Неисключительно приобретает замок, если он немедленно доступен. |
long |
tryReadLock |
Неисключительно приобретает замок, если он доступен в течение заданного времени и текущий поток не был прерван. |
boolean |
tryUnlockRead() |
Освобождает одну блокировку чтения, если она удерживается, без необходимости значения штампа. |
boolean |
tryUnlockWrite() |
Освобождает запись, если она удерживается, без необходимости значения штампа. |
long |
tryWriteLock() |
Исключительно приобретает замок, если он немедленно доступен. |
long |
tryWriteLock |
Исключительно приобретает замок, если он доступен в течение заданного времени и текущий поток не был прерван. |
void |
unlock |
Если состояние замка соответствует заданному штампу, освобождает соответствующий режим замка. |
void |
unlockRead |
Если состояние замка соответствует заданному штампу, освобождает неисключительный замок. |
void |
unlockWrite |
Если состояние замка соответствует заданному штампу, освобождает исключительный замок. |
boolean |
validate |
Возвращает true, если замок не был приобретён исключительно с момента выдачи данного штампа. |
long |
writeLock() |
Исключительно приобретает замок, блокируя, если необходимо, до тех пор, пока он не станет доступным. |
long |
writeLockInterruptibly() |
Исключительно приобретает замок, блокируя, если необходимо, до тех пор, пока он не станет доступным или текущий поток не будет прерван. |
Подробное описание конструкторов
StampedLock
public StampedLock()
Подробное описание методов
writeLock
public long writeLock()
- Возвращает:
- штамп записи, который можно использовать для разблокировки или изменения режима
tryWriteLock
public long tryWriteLock()
- Возвращает:
- штамп записи, который можно использовать для разблокировки или изменения режима, или ноль, если блокировка недоступна
tryWriteLock
public long tryWriteLock(long time, TimeUnit unit) throws InterruptedException
Lock.tryLock(long,TimeUnit).- Параметры:
-
time- максимальное время ожидания блокировки -
unit- единица измерения времени для аргументаtime - Возвращает:
- штамп записи, который можно использовать для разблокировки или изменения режима, или ноль, если блокировка недоступна
- Исключения:
-
InterruptedException- если текущий поток прерван до приобретения блокировки
writeLockInterruptibly
public long writeLockInterruptibly() throws InterruptedException
Lock.lockInterruptibly().- Возвращает:
- штамп записи, который можно использовать для разблокировки или изменения режима
- Исключения:
-
InterruptedException- если текущий поток прерван до приобретения блокировки
readLock
public long readLock()
- Возвращает:
- штамп чтения, который можно использовать для разблокировки или изменения режима
tryReadLock
public long tryReadLock()
- Возвращает:
- штамп чтения, который можно использовать для разблокировки или изменения режима, или ноль, если блокировка недоступна
tryReadLock
public long tryReadLock(long time, TimeUnit unit) throws InterruptedException
Lock.tryLock(long,TimeUnit).- Параметры:
-
time- максимальное время ожидания блокировки -
unit- единица измерения времени для аргументаtime - Возвращает:
- штамп чтения, который можно использовать для разблокировки или изменения режима, или ноль, если блокировка недоступна
- Исключения:
-
InterruptedException- если текущий поток прерван до приобретения блокировки
readLockInterruptibly
public long readLockInterruptibly() throws InterruptedException
Lock.lockInterruptibly().- Возвращает:
- штамп чтения, который можно использовать для разблокировки или изменения режима
- Исключения:
-
InterruptedException- если текущий поток прерван до приобретения блокировки
tryOptimisticRead
public long tryOptimisticRead()
- Возвращает:
- валидный штамп оптимистического чтения, или ноль, если блокировка захвачена исключительно
validate
public boolean validate(long stamp)
tryOptimisticRead() или метода блокировки для этой блокировки, не имеет определенного эффекта или результата.- Параметры:
-
stamp- штамп - Возвращает:
-
true, если блокировка не была захвачена исключительно с момента выдачи данного штампа; в противном случае false
unlockWrite
public void unlockWrite(long stamp)
- Параметры:
-
stamp- штамп, возвращенный операцией записи блокировки - Исключения:
-
IllegalMonitorStateException- если штамп не соответствует текущему состоянию этой блокировки
unlockRead
public void unlockRead(long stamp)
- Параметры:
-
stamp- штамп, возвращенный операцией чтения блокировки - Исключения:
-
IllegalMonitorStateException- если штамп не соответствует текущему состоянию этой блокировки
unlock
public void unlock(long stamp)
- Параметры:
-
stamp- штамп, возвращенный операцией блокировки - Исключения:
-
IllegalMonitorStateException- если штамп не соответствует текущему состоянию этой блокировки
tryConvertToWriteLock
public long tryConvertToWriteLock(long stamp)
- Параметры:
-
stamp- штамп - Возвращает:
- валидный штамп записи, или ноль в случае неудачи
tryConvertToReadLock
public long tryConvertToReadLock(long stamp)
- Параметры:
-
stamp- штамп - Возвращает:
- валидный штамп чтения, или ноль в случае неудачи
tryConvertToOptimisticRead
public long tryConvertToOptimisticRead(long stamp)
- Параметры:
-
stamp- штамп - Возвращает:
- валидный штамп оптимистического чтения, или ноль в случае неудачи
tryUnlockWrite
public boolean tryUnlockWrite()
- Возвращает:
-
true, если блокировка удерживалась, иначе false
tryUnlockRead
public boolean tryUnlockRead()
- Возвращает:
-
true, если блокировка чтения удерживалась, иначе false
isWriteLocked
public boolean isWriteLocked()
true, если блокировка в настоящее время удерживается исключительно.- Возвращает:
-
true, если блокировка в настоящее время удерживается исключительно
isReadLocked
public boolean isReadLocked()
true, если блокировка в настоящее время удерживается неисключительно.- Возвращает:
-
true, если блокировка в настоящее время удерживается неисключительно
isWriteLockStamp
public static boolean isWriteLockStamp(long stamp)
tryConvertToWriteLock(long), например:
long stamp = sl.tryOptimisticRead();
try {
...
stamp = sl.tryConvertToWriteLock(stamp);
...
} finally {
if (StampedLock.isWriteLockStamp(stamp))
sl.unlockWrite(stamp);
}
- Parameters:
-
stamp- штамп, возвращённый предыдущей операцией StampedLock - Returns:
-
trueесли штамп был возвращён успешной операцией взятия записи блокировки - Since:
- 10
isReadLockStamp
public static boolean isReadLockStamp(long stamp)
tryConvertToReadLock(long), например:
long stamp = sl.tryOptimisticRead();
try {
...
stamp = sl.tryConvertToReadLock(stamp);
...
} finally {
if (StampedLock.isReadLockStamp(stamp))
sl.unlockRead(stamp);
}
- Parameters:
-
stamp- штамп, возвращённый предыдущей операцией StampedLock - Returns:
-
trueесли штамп был возвращён успешной операцией взятия блокировки для чтения - Since:
- 10
isLockStamp
public static boolean isLockStamp(long stamp)
tryConvertToReadLock(long) и tryConvertToWriteLock(long), например:
long stamp = sl.tryOptimisticRead();
try {
...
stamp = sl.tryConvertToReadLock(stamp);
...
stamp = sl.tryConvertToWriteLock(stamp);
...
} finally {
if (StampedLock.isLockStamp(stamp))
sl.unlock(stamp);
}
- Parameters:
-
stamp- штамп, возвращённый предыдущей операцией StampedLock - Returns:
-
trueесли штамп был возвращён успешной операцией взятия блокировки для чтения или записи - Since:
- 10
isOptimisticReadStamp
public static boolean isOptimisticReadStamp(long stamp)
- Parameters:
-
stamp- штамп, возвращённый предыдущей операцией StampedLock - Returns:
-
trueесли штамп был возвращён успешной операцией оптимистического чтения, то есть, ненулевым результатом отtryOptimisticRead()илиtryConvertToOptimisticRead(long) - Since:
- 10
getReadLockCount
public int getReadLockCount()
- Returns:
- количество удерживаемых блокировок для чтения
toString
public String toString()
"Unlocked" или строку "Write-locked" или строку "Read-locks:", за которой следует текущее количество удерживаемых блокировок для чтения.asReadLock
public Lock asReadLock()
Lock этой StampedLock, в котором метод Lock.lock() отображается на readLock(), и аналогично для других методов. Возвращаемый Lock не поддерживает метод Condition; метод Lock.newCondition() вызывает исключение UnsupportedOperationException.- Returns:
- блокировку
asWriteLock
public Lock asWriteLock()
Lock этой StampedLock, в котором метод Lock.lock() отображается на writeLock(), и аналогично для других методов. Возвращаемый Lock не поддерживает метод Condition; метод Lock.newCondition() вызывает исключение UnsupportedOperationException.- Returns:
- блокировку
asReadWriteLock
public ReadWriteLock asReadWriteLock()
ReadWriteLock этой StampedLock, в котором метод ReadWriteLock.readLock() отображается на asReadLock(), и ReadWriteLock.writeLock() на asWriteLock().- Returns:
- блокировку
© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://download.java.net/java/early_access/jdk24/docs/api/java.base/java/util/concurrent/locks/StampedLock.html