java.lang.Object java.util.concurrent.locks.ReentrantLock
public class ReentrantLock
A reentrant mutual exclusion Lock with the same basic behavior and semantics as the implicit monitor lock accessed using synchronized methods and statements, but with extended capabilities.
A ReentrantLock is owned by the thread last successfully locking, but not yet unlocking it. A thread invoking lock will return, successfully acquiring the lock, when the lock is not owned by another thread. The method will return immediately if the current thread already owns the lock. This can be checked using methods isHeldByCurrentThread() , and getHoldCount() .
The constructor for this class accepts an optional fairness parameter. When set
true,
true
,
under contention, locks favor granting access to the longest-waiting thread. Otherwise this lock does not guarantee any particular access order. Programs using fair locks accessed by many threads may display lower overall throughput (i.e., are slower; often much slower) than those using the default setting, but have smaller variances in times to obtain locks and guarantee lack of starvation. Note however, that fairness of locks does not guarantee fairness of thread scheduling. Thus, one of many threads using a fair lock may obtain it multiple times in succession while other active threads are not progressing and not currently holding the lock. Also note that the untimed
tryLock
method does not honor the fairness setting. It will succeed if the lock is available even if other threads are waiting.
It is recommended practice to always immediately follow a call to lock with a try block, most typically in a before/after construction such as:
class X { private final ReentrantLock lock = new ReentrantLock(); // ... public void m() { lock.lock(); // block until condition holds try { // ... method body } finally { lock.unlock() } } }
In addition to implementing the
Lock
interface, this class defines methods
isLocked
and
getLockQueueLength,
getLockQueueLength
,
as well as some associated
protected
access methods that may be useful for instrumentation and monitoring.
Serialization of this class behaves in the same way as built-in locks: a deserialized lock is in the unlocked state, regardless of its state when serialized.
This lock supports a maximum of 2147483647 recursive locks by the same thread. Attempts to exceed this limit result in Error throws from locking methods.
Constructor Summary | |
---|---|
ReentrantLock
() Creates an instance of ReentrantLock. |
|
ReentrantLock
(boolean fair) Creates an instance of ReentrantLock with the given fairness policy. |
Method Summary | |
---|---|
int |
getHoldCount
() Queries the number of holds on this lock by the current thread. |
protected Thread |
getOwner
() Returns the thread that currently owns this lock, or null if not owned. |
protected Collection < Thread > |
getQueuedThreads
() Returns a collection containing threads that may be waiting to acquire this lock. |
int |
getQueueLength
() Returns an estimate of the number of threads waiting to acquire this lock. |
protected Collection < Thread > |
getWaitingThreads
(
Condition
condition) Returns a collection containing those threads that may be waiting on the given condition associated with this lock. |
int |
getWaitQueueLength
(
Condition
condition) Returns an estimate of the number of threads waiting on the given condition associated with this lock. |
boolean |
hasQueuedThread
(
Thread
thread) Queries whether the given thread is waiting to acquire this lock. |
boolean |
hasQueuedThreads
() Queries whether any threads are waiting to acquire this lock. |
boolean |
hasWaiters
(
Condition
condition) Queries whether any threads are waiting on the given condition associated with this lock. |
boolean |
isFair
() Returns true if this lock has fairness set true. |
boolean |
isHeldByCurrentThread
() Queries if this lock is held by the current thread. |
boolean |
isLocked
() Queries if this lock is held by any thread. |
void |
lock
() Acquires the lock. |
void |
lockInterruptibly
() Acquires the lock unless the current thread is interrupted . |
Condition |
newCondition
() Returns a Condition instance for use with this Lock instance. |
String |
toString
() Returns a string identifying this lock, as well as its lock state. |
boolean |
tryLock
() Acquires the lock only if it is not held by another thread at the time of invocation. |
boolean |
tryLock
(long timeout,
TimeUnit
unit) Acquires the lock if it is not held by another thread within the given waiting time and the current thread has not been interrupted . |
void |
unlock
() Attempts to release this lock. |
Methods inherited from class java.lang. Object |
---|
clone , equals , finalize , getClass , hashCode , notify , notifyAll , wait , wait , wait |
Constructor Detail |
---|
public ReentrantLock()
public ReentrantLock(boolean fair)
Method Detail |
---|
public void lock()
Acquires the lock if it is not held by another thread and returns immediately, setting the lock hold count to one.
If the current thread already holds the lock then the hold count is incremented by one and the method returns immediately.
If the lock is held by another thread then the current thread becomes disabled for thread scheduling purposes and lies dormant until the lock has been acquired, at which time the lock hold count is set to one.
public void lockInterruptibly() throws InterruptedException
Acquires the lock if it is not held by another thread and returns immediately, setting the lock hold count to one.
If the current thread already holds this lock then the hold count is incremented by one and the method returns immediately.
If the lock is held by another thread then the current thread becomes disabled for thread scheduling purposes and lies dormant until one of two things happens:
If the lock is acquired by the current thread then the lock hold count is set to one.
If the current thread:
In this implementation, as this method is an explicit interruption point, preference is given to responding to the interrupt over normal or reentrant acquisition of the lock.
public boolean tryLock()
Acquires the lock if it is not held by another thread and returns immediately with the value
true,
true
,
setting the lock hold count to one. Even when this lock has been set to use a fair ordering policy, a call to
tryLock()
will immediately acquire the lock if it is available, whether or not other threads are currently waiting for the lock. This "barging" behavior can be useful in certain circumstances, even though it breaks fairness. If you want to honor the fairness setting for this lock, then use
tryLock(0, TimeUnit.SECONDS)
which is almost equivalent (it also detects interruption).
If the current thread already holds this lock then the hold count is incremented by one and the method returns
true.
true
.
If the lock is held by another thread then this method will return immediately with the value
false.
false
.
public boolean tryLock(long timeout, TimeUnit unit) throws InterruptedException
Acquires the lock if it is not held by another thread and returns immediately with the value
true,
true
,
setting the lock hold count to one. If this lock has been set to use a fair ordering policy then an available lock will not be acquired if any other threads are waiting for the lock. This is in contrast to the
tryLock()
method. If you want a timed
tryLock
that does permit barging on a fair lock then combine the timed and un-timed forms together:
if (lock.tryLock() || lock.tryLock(timeout, unit) ) { ... }
If the current thread already holds this lock then the hold count is incremented by one and the method returns
true.
true
.
If the lock is held by another thread then the current thread becomes disabled for thread scheduling purposes and lies dormant until one of three things happens:
If the lock is acquired then the value true is returned and the lock hold count is set to one.
If the current thread:
If the specified waiting time elapses then the value false is returned. If the time is less than or equal to zero, the method will not wait at all.
In this implementation, as this method is an explicit interruption point, preference is given to responding to the interrupt over normal or reentrant acquisition of the lock, and over reporting the elapse of the waiting time.
public void unlock()
If the current thread is the holder of this lock then the hold count is decremented. If the hold count is now zero then the lock is released. If the current thread is not the holder of this lock then IllegalMonitorStateException is thrown.
public Condition newCondition()
The returned Condition instance supports the same usages as do the Object monitor methods ( wait , notify , and notifyAll ) when used with the built-in monitor lock.
public int getHoldCount()
A thread has a hold on a lock for each lock action that is not matched by an unlock action.
The hold count information is typically only used for testing and debugging purposes. For example, if a certain section of code should not be entered with the lock already held then we can assert that fact:
class X { ReentrantLock lock = new ReentrantLock(); // ... public void m() { assert lock.getHoldCount() == 0; lock.lock(); try { // ... method body } finally { lock.unlock(); } } }
public boolean isHeldByCurrentThread()
Analogous to the Thread.holdsLock(java.lang.Object) method for built-in monitor locks, this method is typically used for debugging and testing. For example, a method that should only be called while a lock is held can assert that this is the case:
class X { ReentrantLock lock = new ReentrantLock(); // ... public void m() { assert lock.isHeldByCurrentThread(); // ... method body } }
It can also be used to ensure that a reentrant lock is used in a non-reentrant manner, for example:
class X { ReentrantLock lock = new ReentrantLock(); // ... public void m() { assert !lock.isHeldByCurrentThread(); lock.lock(); try { // ... method body } finally { lock.unlock(); } } }
public boolean isLocked()
public final boolean isFair()
protected Thread getOwner()
public final boolean hasQueuedThreads()
public final boolean hasQueuedThread(Thread thread)
public final int getQueueLength()
protected Collection<Thread> getQueuedThreads()
public boolean hasWaiters(Condition condition)
public int getWaitQueueLength(Condition condition)
protected Collection<Thread> getWaitingThreads(Condition condition)
public String toString()