Package org.eclipse.jetty.util.thread

Class AutoLock.WithCondition

java.lang.Object

org.eclipse.jetty.util.thread.AutoLock

org.eclipse.jetty.util.thread.AutoLock.WithCondition

All Implemented Interfaces:

Serializable, AutoCloseable

Enclosing class:

AutoLock

public static class AutoLock.WithCondition
extends AutoLock

A reentrant lock with a condition that can be used in a try-with-resources statement.

Typical usage:

 // Waiting
 try (AutoLock lock = _lock.lock())
 {
     lock.await();
 }

 // Signaling
 try (AutoLock lock = _lock.lock())
 {
     lock.signalAll();
 }
 

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jetty.util.thread.AutoLock

AutoLock.WithCondition

Constructor Summary

Constructors

Constructor	Description
WithCondition()

Method Summary

Modifier and Type	Method	Description
void	await()
boolean	await(long time, TimeUnit unit)
AutoLock.WithCondition	lock()	Acquires the lock.
void	signal()
void	signalAll()
AutoLock.WithCondition	tryLock()	Tries to acquire the lock.

Methods inherited from class org.eclipse.jetty.util.thread.AutoLock

close, isHeldByCurrentThread, newCondition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WithCondition

public WithCondition()

Method Details

lock

public AutoLock.WithCondition lock()

Description copied from class: AutoLock

Acquires the lock.

Overrides:

lock in class AutoLock

Returns:

this AutoLock for unlocking

tryLock

public AutoLock.WithCondition tryLock()

Description copied from class: AutoLock

Tries to acquire the lock.

Whether the lock was acquired can be tested with AutoLock.isHeldByCurrentThread().

Typical usage of this method is in toString(), to avoid deadlocks when the implementation needs to lock to retrieve a consistent state to produce the string.

Overrides:

tryLock in class AutoLock

Returns:

this AutoLock for unlocking

signal

public void signal()

See Also:

• Condition.signal()

signalAll

public void signalAll()

See Also:

• Condition.signalAll()

await

public void await()
           throws InterruptedException

Throws:

InterruptedException - if the current thread is interrupted

See Also:

• Condition.await()

await

public boolean await(long time,
 TimeUnit unit)
              throws InterruptedException

Parameters:

time - the time to wait

unit - the time unit

Returns:

false if the waiting time elapsed

Throws:

InterruptedException - if the current thread is interrupted

See Also:

• Condition.await(long, TimeUnit)