Класс ReentrantLock

Рекурсивный взаимный исключающий Lock с тем же базовым поведением и семантикой, что и неявный мониторный замок, доступ к которому осуществляется с помощью synchronized методов и инструкций, но с расширенными возможностями.

ReentrantLock принадлежит потоку, последнему успешно заблокировавшему, но ещё не разблокировавшему его. Поток, вызывающий lock , вернётся, успешно получив замок, когда замок не принадлежит другому потоку. Метод вернётся сразу же, если текущий поток уже владеет замком. Это можно проверить с помощью методов isHeldByCurrentThread() и getHoldCount().

Конструктор этого класса принимает необязательный параметр справедливости. Когда он установлен true, при конкуренции замки отдают предпочтение предоставлению доступа потоку, который дольше всего ожидает. В противном случае этот замок не гарантирует какой-либо определённый порядок доступа. Программы, использующие справедливые замки, доступ к которым осуществляется многими потоками, могут демонстрировать более низкую общую производительность (то есть, медленнее; часто намного медленнее), чем те, которые используют настройки по умолчанию, но имеют меньшие колебания во времени получения замков и гарантируют отсутствие голодания. Однако следует отметить, что справедливость замков не гарантирует справедливости планирования потоков. Таким образом, один из многих потоков, использующих справедливый замок, может получить его несколько раз подряд, в то время как другие активные потоки не прогрессируют и в настоящее время не владеют замком. Также следует отметить, что асинхронный метод tryLock() не учитывает настройку справедливости. Он будет успешным, если замок доступен, даже если другие потоки ожидают.

Рекомендуется всегда сразу же после вызова lock использовать try блок, чаще всего в конструкции типа «до/после»:

class X {
   private final ReentrantLock lock = new ReentrantLock();
   // ...

   public void m() {
     lock.lock();  // block until condition holds
     try {
       // ... method body
     } finally {
       lock.unlock()
     }
   }
 }

Помимо реализации интерфейса Lock, этот класс определяет ряд public и protected методов для проверки состояния замка. Некоторые из этих методов полезны только для инструментирования и мониторинга.

Сериализация этого класса ведёт себя так же, как встроенные замки: десериализованный замок находится в разблокированном состоянии, независимо от его состояния при сериализации.

Этот замок поддерживает максимальное количество 2147483647 рекурсивных блокировок одним и тем же потоком. Попытки превысить этот лимит приводят к Error выбрасываемым из методов блокировки.

Конструкторы

ReentrantLock

public ReentrantLock()

Создаёт экземпляр ReentrantLock. Это эквивалентно использованию ReentrantLock(false).

ReentrantLock

public ReentrantLock(boolean fair)

Создаёт экземпляр ReentrantLock с заданной политикой честности.

Параметры:

fair - true если для этого мьютекса должна использоваться политика честного порядка очереди

Методы

lock

public void lock()

Определено в:

lock в интерфейсе Lock

lockInterruptibly

public void lockInterruptibly()
                       throws InterruptedException

Определено в:

lockInterruptibly в интерфейсе Lock

Исключения:

InterruptedException - если текущая нить прервана

tryLock

public boolean tryLock()

Определено в:

tryLock в интерфейсе Lock

Возвращает:

true если мьютекс был свободен и был приобретён текущей нитью, или мьютекс уже был удерживаем текущей нитью; и false в противном случае

tryLock

public boolean tryLock(long timeout,
                       TimeUnit unit)
                throws InterruptedException

if (lock.tryLock() ||
     lock.tryLock(timeout, unit)) {
   ...
 }

Определено в:

tryLock в интерфейсе Lock

Параметры:

timeout - время ожидания мьютекса

unit - единица измерения времени ожидания

Возвращает:

true если мьютекс был свободен и был приобретён текущей нитью, или мьютекс уже был удерживаем текущей нитью; и false если время ожидания истекло до приобретения мьютекса

Исключения:

InterruptedException - если текущая нить прервана

NullPointerException - если единица измерения времени равна null

unlock

public void unlock()

Определено в:

unlock в интерфейсе Lock

Исключения:

IllegalMonitorStateException - если текущая нить не держит этот мьютекс

newCondition

public Condition newCondition()

Определено в:

newCondition в интерфейсе Lock

Возвращает:

объект Condition

getHoldCount

public int getHoldCount()

class X {
   ReentrantLock lock = new ReentrantLock();
   // ...
   public void m() {
     assert lock.getHoldCount() == 0;
     lock.lock();
     try {
       // ... method body
     } finally {
       lock.unlock();
     }
   }
 }

Возвращает:

количество удержаний этого мьютекса текущей нитью или ноль, если этот мьютекс не удерживается текущей нитью

isHeldByCurrentThread

public boolean isHeldByCurrentThread()

class X {
   ReentrantLock lock = new ReentrantLock();
   // ...

   public void m() {
       assert lock.isHeldByCurrentThread();
       // ... method body
   }
 }

class X {
   ReentrantLock lock = new ReentrantLock();
   // ...

   public void m() {
       assert !lock.isHeldByCurrentThread();
       lock.lock();
       try {
           // ... method body
       } finally {
           lock.unlock();
       }
   }
 }

Возвращает:

true если текущая нить удерживает этот мьютекс и false в противном случае

isLocked

public boolean isLocked()

Запрашивает, удерживается ли этот мьютекс какой-либо нитью. Этот метод предназначен для использования при мониторинге состояния системы, а не для управления синхронизацией.

Возвращает:

true если какой-либо поток удерживает этот мьютекс и false в противном случае

isFair

public final boolean isFair()

Возвращает true , если для этого мьютекса установлена честность.

Возвращает:

true если для этого мьютекса установлена честность

getOwner

protected Thread getOwner()

Возвращает поток, который в данный момент владеет этим замком, или null если им никто не владеет. Когда этот метод вызывается потоком, который не является владельцем, возвращаемое значение отражает приблизительное текущее состояние замка. Например, владелец может временно null даже если есть потоки, пытающиеся получить замок, но ещё не сделавшие этого. Этот метод предназначен для облегчения создания подклассов, предоставляющих более широкие возможности мониторинга замка.

Возвращает:

владелец, или null если им никто не владеет

hasQueuedThreads

public final boolean hasQueuedThreads()

Определяет, ожидают ли какие-либо потоки получения этого замка. Обратите внимание, что из-за возможных отмен в любой момент, возвращаемое значение true не гарантирует, что какой-либо другой поток когда-либо получит этот замок. Этот метод предназначен в основном для мониторинга состояния системы.

Возвращает:

true если могут быть другие потоки, ожидающие получения замка

hasQueuedThread

public final boolean hasQueuedThread(Thread thread)

Определяет, ожидает ли данный поток получения этого замка. Обратите внимание, что из-за возможных отмен в любой момент, возвращаемое значение true не гарантирует, что этот поток когда-либо получит замок. Этот метод предназначен в основном для мониторинга состояния системы.

Параметры:

thread - поток

Возвращает:

true если данный поток стоит в очереди, ожидая этот замок

Исключения:

NullPointerException - если поток null

getQueueLength

public final int getQueueLength()

Возвращает приблизительное количество потоков, ожидающих получения этого замка. Значение является лишь приблизительным, поскольку количество потоков может динамически меняться во время обхода внутренних структур данных. Этот метод предназначен для мониторинга состояния системы, а не для управления синхронизацией.

Возвращает:

приблизительное количество потоков, ожидающих этот замок

getQueuedThreads

protected Collection<Thread> getQueuedThreads()

Возвращает коллекцию, содержащую потоки, которые могут ожидать получения этого замка. Поскольку фактический набор потоков может динамически меняться во время построения этого результата, возвращаемая коллекция является лишь приблизительной. Элементы возвращаемой коллекции не упорядочены. Этот метод предназначен для облегчения создания подклассов, предоставляющих более широкие возможности мониторинга.

Возвращает:

коллекцию потоков

hasWaiters

public boolean hasWaiters(Condition condition)

Определяет, ожидают ли какие-либо потоки условного ожидания, связанного с этим замком. Обратите внимание, что из-за таймаутов и прерываний в любой момент возвращаемое значение true не гарантирует, что в будущем signal разбудит какие-либо потоки. Этот метод предназначен в основном для мониторинга состояния системы.

Параметры:

condition - условное ожидание

Возвращает:

true если есть ожидающие потоки

Исключения:

IllegalMonitorStateException - если этот замок не удерживается

IllegalArgumentException - если данное условное ожидание не связано с этим замком

NullPointerException - если условное ожидание null

getWaitQueueLength

public int getWaitQueueLength(Condition condition)

Возвращает приблизительное количество потоков, ожидающих условного ожидания, связанного с этим замком. Обратите внимание, что из-за таймаутов и прерываний в любой момент приблизительное значение служит лишь верхней границей фактического числа ожидающих. Этот метод предназначен для мониторинга состояния системы, а не для управления синхронизацией.

Параметры:

condition - условное ожидание

Возвращает:

приблизительное количество ожидающих потоков

Исключения:

IllegalMonitorStateException - если этот замок не удерживается

IllegalArgumentException - если данное условное ожидание не связано с этим замком

NullPointerException - если условное ожидание null

getWaitingThreads

protected Collection<Thread> getWaitingThreads(Condition condition)

Возвращает коллекцию, содержащую потоки, которые могут ожидать условного ожидания, связанного с этим замком. Поскольку фактический набор потоков может динамически меняться во время построения этого результата, возвращаемая коллекция является лишь приблизительной. Элементы возвращаемой коллекции не упорядочены. Этот метод предназначен для облегчения создания подклассов, предоставляющих более широкие возможности мониторинга условного ожидания.

Параметры:

condition - условное ожидание

Возвращает:

коллекцию потоков

Исключения:

IllegalMonitorStateException - если этот замок не удерживается

IllegalArgumentException - если данное условное ожидание не связано с этим замком

NullPointerException - если условное ожидание null

toString

public String toString()

Возвращает строку, идентифицирующую этот замок, а также его состояние. Состояние, в скобках, содержит либо строку "Unlocked" , либо строку "Locked by" , за которой следует имя владеющего потока.

Переопределяет:

toString в классе Object

Возвращает:

строку, идентифицирующую этот замок, а также его состояние