java.lang.Object | ||
↳ | java.util.concurrent.locks.AbstractOwnableSynchronizer | |
↳ | java.util.concurrent.locks.AbstractQueuedLongSynchronizer |
A version of AbstractQueuedSynchronizer
in
which synchronization state is maintained as a long
.
This class has exactly the same structure, properties, and methods
as AbstractQueuedSynchronizer
with the exception
that all state-related parameters and results are defined
as long
rather than int
. This class
may be useful when creating synchronizers such as
multilevel locks and barriers that require
64 bits of state.
See AbstractQueuedSynchronizer
for usage
notes and examples.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
AbstractQueuedLongSynchronizer.ConditionObject |
Condition implementation for a AbstractQueuedLongSynchronizer serving as the basis of a Lock implementation.
|
Protected Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creates a new
AbstractQueuedLongSynchronizer instance
with initial synchronization state of zero.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Acquires in exclusive mode, ignoring interrupts.
| |||||||||||
Acquires in exclusive mode, aborting if interrupted.
| |||||||||||
Acquires in shared mode, ignoring interrupts.
| |||||||||||
Acquires in shared mode, aborting if interrupted.
| |||||||||||
Returns a collection containing threads that may be waiting to
acquire in exclusive mode.
| |||||||||||
Returns the first (longest-waiting) thread in the queue, or
null if no threads are currently queued.
| |||||||||||
Returns an estimate of the number of threads waiting to
acquire.
| |||||||||||
Returns a collection containing threads that may be waiting to
acquire.
| |||||||||||
Returns a collection containing threads that may be waiting to
acquire in shared mode.
| |||||||||||
Returns an estimate of the number of threads waiting on the
given condition associated with this synchronizer.
| |||||||||||
Returns a collection containing those threads that may be
waiting on the given condition associated with this
synchronizer.
| |||||||||||
Queries whether any threads have ever contended to acquire this
synchronizer; that is if an acquire method has ever blocked.
| |||||||||||
Queries whether any threads have been waiting to acquire longer
than the current thread.
| |||||||||||
Queries whether any threads are waiting to acquire.
| |||||||||||
Queries whether any threads are waiting on the given condition
associated with this synchronizer.
| |||||||||||
Returns true if the given thread is currently queued.
| |||||||||||
Queries whether the given ConditionObject
uses this synchronizer as its lock.
| |||||||||||
Releases in exclusive mode.
| |||||||||||
Releases in shared mode.
| |||||||||||
Returns a string identifying this synchronizer, as well as its state.
| |||||||||||
Attempts to acquire in exclusive mode, aborting if interrupted,
and failing if the given timeout elapses.
| |||||||||||
Attempts to acquire in shared mode, aborting if interrupted, and
failing if the given timeout elapses.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Atomically sets synchronization state to the given updated
value if the current state value equals the expected value.
| |||||||||||
Returns the current value of synchronization state.
| |||||||||||
Returns
true if synchronization is held exclusively with
respect to the current (calling) thread.
| |||||||||||
Sets the value of synchronization state.
| |||||||||||
Attempts to acquire in exclusive mode.
| |||||||||||
Attempts to acquire in shared mode.
| |||||||||||
Attempts to set the state to reflect a release in exclusive
mode.
| |||||||||||
Attempts to set the state to reflect a release in shared mode.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.util.concurrent.locks.AbstractOwnableSynchronizer
| |||||||||||
From class
java.lang.Object
|
Creates a new AbstractQueuedLongSynchronizer
instance
with initial synchronization state of zero.
Acquires in exclusive mode, ignoring interrupts. Implemented
by invoking at least once tryAcquire(long)
,
returning on success. Otherwise the thread is queued, possibly
repeatedly blocking and unblocking, invoking tryAcquire(long)
until success. This method can be used
to implement method lock()
.
arg | the acquire argument. This value is conveyed to
tryAcquire(long) but is otherwise uninterpreted and
can represent anything you like.
|
---|
Acquires in exclusive mode, aborting if interrupted.
Implemented by first checking interrupt status, then invoking
at least once tryAcquire(long)
, returning on
success. Otherwise the thread is queued, possibly repeatedly
blocking and unblocking, invoking tryAcquire(long)
until success or the thread is interrupted. This method can be
used to implement method lockInterruptibly()
.
arg | the acquire argument. This value is conveyed to
tryAcquire(long) but is otherwise uninterpreted and
can represent anything you like. |
---|
InterruptedException | if the current thread is interrupted |
---|
Acquires in shared mode, ignoring interrupts. Implemented by
first invoking at least once tryAcquireShared(long)
,
returning on success. Otherwise the thread is queued, possibly
repeatedly blocking and unblocking, invoking tryAcquireShared(long)
until success.
arg | the acquire argument. This value is conveyed to
tryAcquireShared(long) but is otherwise uninterpreted
and can represent anything you like.
|
---|
Acquires in shared mode, aborting if interrupted. Implemented
by first checking interrupt status, then invoking at least once
tryAcquireShared(long)
, returning on success. Otherwise the
thread is queued, possibly repeatedly blocking and unblocking,
invoking tryAcquireShared(long)
until success or the thread
is interrupted.
arg | the acquire argument.
This value is conveyed to tryAcquireShared(long) but is
otherwise uninterpreted and can represent anything
you like. |
---|
InterruptedException | if the current thread is interrupted |
---|
Returns a collection containing threads that may be waiting to
acquire in exclusive mode. This has the same properties
as getQueuedThreads()
except that it only returns
those threads waiting due to an exclusive acquire.
Returns the first (longest-waiting) thread in the queue, or
null
if no threads are currently queued.
In this implementation, this operation normally returns in constant time, but may iterate upon contention if other threads are concurrently modifying the queue.
null
if no threads are currently queued
Returns an estimate of the number of threads waiting to acquire. The value is only an estimate because the number of threads may change dynamically while this method traverses internal data structures. This method is designed for use in monitoring system state, not for synchronization control.
Returns a collection containing threads that may be waiting to acquire. Because the actual set of threads may change dynamically while constructing this result, the returned collection is only a best-effort estimate. The elements of the returned collection are in no particular order. This method is designed to facilitate construction of subclasses that provide more extensive monitoring facilities.
Returns a collection containing threads that may be waiting to
acquire in shared mode. This has the same properties
as getQueuedThreads()
except that it only returns
those threads waiting due to a shared acquire.
Returns an estimate of the number of threads waiting on the given condition associated with this synchronizer. Note that because timeouts and interrupts may occur at any time, the estimate serves only as an upper bound on the actual number of waiters. This method is designed for use in monitoring of the system state, not for synchronization control.
condition | the condition |
---|
IllegalMonitorStateException | if exclusive synchronization is not held |
---|---|
IllegalArgumentException | if the given condition is not associated with this synchronizer |
NullPointerException | if the condition is null |
Returns a collection containing those threads that may be waiting on the given condition associated with this synchronizer. Because the actual set of threads may change dynamically while constructing this result, the returned collection is only a best-effort estimate. The elements of the returned collection are in no particular order.
condition | the condition |
---|
IllegalMonitorStateException | if exclusive synchronization is not held |
---|---|
IllegalArgumentException | if the given condition is not associated with this synchronizer |
NullPointerException | if the condition is null |
Queries whether any threads have ever contended to acquire this synchronizer; that is if an acquire method has ever blocked.
In this implementation, this operation returns in constant time.
true
if there has ever been contention
Queries whether any threads have been waiting to acquire longer than the current thread.
An invocation of this method is equivalent to (but may be more efficient than):
getFirstQueuedThread() != Thread.currentThread() &&
hasQueuedThreads()
Note that because cancellations due to interrupts and
timeouts may occur at any time, a true
return does not
guarantee that some other thread will acquire before the current
thread. Likewise, it is possible for another thread to win a
race to enqueue after this method has returned false
,
due to the queue being empty.
This method is designed to be used by a fair synchronizer to
avoid barging.
Such a synchronizer's tryAcquire(long)
method should return
false
, and its tryAcquireShared(long)
method should
return a negative value, if this method returns true
(unless this is a reentrant acquire). For example, the tryAcquire
method for a fair, reentrant, exclusive mode
synchronizer might look like this:
protected boolean tryAcquire(int arg) {
if (isHeldExclusively()) {
// A reentrant acquire; increment hold count
return true;
else if (hasQueuedPredecessors()) {
return false;
} else {
// try to acquire normally
}
}}
true
if there is a queued thread preceding the
current thread, and false
if the current thread
is at the head of the queue or the queue is emptyQueries whether any threads are waiting to acquire. Note that
because cancellations due to interrupts and timeouts may occur
at any time, a true
return does not guarantee that any
other thread will ever acquire.
In this implementation, this operation returns in constant time.
true
if there may be other threads waiting to acquire
Queries whether any threads are waiting on the given condition
associated with this synchronizer. Note that because timeouts
and interrupts may occur at any time, a true
return
does not guarantee that a future signal
will awaken
any threads. This method is designed primarily for use in
monitoring of the system state.
condition | the condition |
---|
true
if there are any waiting threadsIllegalMonitorStateException | if exclusive synchronization is not held |
---|---|
IllegalArgumentException | if the given condition is not associated with this synchronizer |
NullPointerException | if the condition is null |
Returns true if the given thread is currently queued.
This implementation traverses the queue to determine presence of the given thread.
thread | the thread |
---|
true
if the given thread is on the queueNullPointerException | if the thread is null |
---|
Queries whether the given ConditionObject uses this synchronizer as its lock.
condition | the condition |
---|
true
if ownedNullPointerException | if the condition is null |
---|
Releases in exclusive mode. Implemented by unblocking one or
more threads if tryRelease(long)
returns true.
This method can be used to implement method unlock()
.
arg | the release argument. This value is conveyed to
tryRelease(long) but is otherwise uninterpreted and
can represent anything you like. |
---|
tryRelease(long)
Releases in shared mode. Implemented by unblocking one or more
threads if tryReleaseShared(long)
returns true.
arg | the release argument. This value is conveyed to
tryReleaseShared(long) but is otherwise uninterpreted
and can represent anything you like. |
---|
tryReleaseShared(long)
Returns a string identifying this synchronizer, as well as its state.
The state, in brackets, includes the String "State ="
followed by the current value of getState()
, and either
"nonempty"
or "empty"
depending on whether the
queue is empty.
Attempts to acquire in exclusive mode, aborting if interrupted,
and failing if the given timeout elapses. Implemented by first
checking interrupt status, then invoking at least once tryAcquire(long)
, returning on success. Otherwise, the thread is
queued, possibly repeatedly blocking and unblocking, invoking
tryAcquire(long)
until success or the thread is interrupted
or the timeout elapses. This method can be used to implement
method tryLock(long, TimeUnit)
.
arg | the acquire argument. This value is conveyed to
tryAcquire(long) but is otherwise uninterpreted and
can represent anything you like. |
---|---|
nanosTimeout | the maximum number of nanoseconds to wait |
true
if acquired; false
if timed outInterruptedException | if the current thread is interrupted |
---|
Attempts to acquire in shared mode, aborting if interrupted, and
failing if the given timeout elapses. Implemented by first
checking interrupt status, then invoking at least once tryAcquireShared(long)
, returning on success. Otherwise, the
thread is queued, possibly repeatedly blocking and unblocking,
invoking tryAcquireShared(long)
until success or the thread
is interrupted or the timeout elapses.
arg | the acquire argument. This value is conveyed to
tryAcquireShared(long) but is otherwise uninterpreted
and can represent anything you like. |
---|---|
nanosTimeout | the maximum number of nanoseconds to wait |
true
if acquired; false
if timed outInterruptedException | if the current thread is interrupted |
---|
Atomically sets synchronization state to the given updated
value if the current state value equals the expected value.
This operation has memory semantics of a volatile
read
and write.
expect | the expected value |
---|---|
update | the new value |
Returns the current value of synchronization state.
This operation has memory semantics of a volatile
read.
Returns true
if synchronization is held exclusively with
respect to the current (calling) thread. This method is invoked
upon each call to a non-waiting AbstractQueuedLongSynchronizer.ConditionObject
method.
(Waiting methods instead invoke release(long)
.)
The default implementation throws UnsupportedOperationException
. This method is invoked
internally only within AbstractQueuedLongSynchronizer.ConditionObject
methods, so need
not be defined if conditions are not used.
true
if synchronization is held exclusively;
false
otherwiseUnsupportedOperationException | if conditions are not supported |
---|
Sets the value of synchronization state.
This operation has memory semantics of a volatile
write.
newState | the new state value |
---|
Attempts to acquire in exclusive mode. This method should query if the state of the object permits it to be acquired in the exclusive mode, and if so to acquire it.
This method is always invoked by the thread performing
acquire. If this method reports failure, the acquire method
may queue the thread, if it is not already queued, until it is
signalled by a release from some other thread. This can be used
to implement method tryLock()
.
The default
implementation throws UnsupportedOperationException
.
arg | the acquire argument. This value is always the one passed to an acquire method, or is the value saved on entry to a condition wait. The value is otherwise uninterpreted and can represent anything you like. |
---|
true
if successful. Upon success, this object has
been acquired.IllegalMonitorStateException | if acquiring would place this synchronizer in an illegal state. This exception must be thrown in a consistent fashion for synchronization to work correctly. |
---|---|
UnsupportedOperationException | if exclusive mode is not supported |
Attempts to acquire in shared mode. This method should query if the state of the object permits it to be acquired in the shared mode, and if so to acquire it.
This method is always invoked by the thread performing acquire. If this method reports failure, the acquire method may queue the thread, if it is not already queued, until it is signalled by a release from some other thread.
The default implementation throws UnsupportedOperationException
.
arg | the acquire argument. This value is always the one passed to an acquire method, or is the value saved on entry to a condition wait. The value is otherwise uninterpreted and can represent anything you like. |
---|
IllegalMonitorStateException | if acquiring would place this synchronizer in an illegal state. This exception must be thrown in a consistent fashion for synchronization to work correctly. |
---|---|
UnsupportedOperationException | if shared mode is not supported |
Attempts to set the state to reflect a release in exclusive mode.
This method is always invoked by the thread performing release.
The default implementation throws
UnsupportedOperationException
.
arg | the release argument. This value is always the one passed to a release method, or the current state value upon entry to a condition wait. The value is otherwise uninterpreted and can represent anything you like. |
---|
true
if this object is now in a fully released
state, so that any waiting threads may attempt to acquire;
and false
otherwise.IllegalMonitorStateException | if releasing would place this synchronizer in an illegal state. This exception must be thrown in a consistent fashion for synchronization to work correctly. |
---|---|
UnsupportedOperationException | if exclusive mode is not supported |
Attempts to set the state to reflect a release in shared mode.
This method is always invoked by the thread performing release.
The default implementation throws
UnsupportedOperationException
.
arg | the release argument. This value is always the one passed to a release method, or the current state value upon entry to a condition wait. The value is otherwise uninterpreted and can represent anything you like. |
---|
true
if this release of shared mode may permit a
waiting acquire (shared or exclusive) to succeed; and
false
otherwiseIllegalMonitorStateException | if releasing would place this synchronizer in an illegal state. This exception must be thrown in a consistent fashion for synchronization to work correctly. |
---|---|
UnsupportedOperationException | if shared mode is not supported |