Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

ReentrantReadWriteLock::ReadLock Class Reference

Inheritance diagram for ReentrantReadWriteLock::ReadLock:

Lock List of all members.

Public Member Functions

 this (ReentrantReadWriteLock lock)
void lock ()
bool tryLock ()
bool tryLock (long timeout, TimeUnit unit)
void unlock ()
Condition newCondition ()
char[] toString ()

Private Attributes

Sync sync

Detailed Description

The lock returned by method ReentrantReadWriteLock.readLock.

Definition at line 420 of file ReadWriteLock.d.


Member Function Documentation

this ReentrantReadWriteLock  lock  )  [inline]
 

Constructor for use by subclasses

Parameters:
lock the outer lock object

Definition at line 427 of file ReadWriteLock.d.

References lock(), and sync.

void lock  )  [inline]
 

Acquires the shared lock.

Acquires the lock if it is not held exclusively by another thread and returns immediately.

If the lock is held exclusively by another thread then the current thread becomes disabled for thread scheduling purposes and lies dormant until the lock has been acquired.

Reimplemented from Lock.

Definition at line 441 of file ReadWriteLock.d.

References AbstractLock::acquireShared(), and sync.

Referenced by this().

bool tryLock  )  [inline]
 

Acquires the shared lock only if it is not held exclusively by another thread at the time of invocation.

Acquires the lock if it is not held exclusively by another thread and returns immediately with the value true. 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 lock is held exclusively by another thread then this method will return immediately with the value false.

'return true if the lock was acquired.

Reimplemented from Lock.

Definition at line 467 of file ReadWriteLock.d.

References ReentrantReadWriteLock::Sync::nonfairTryAcquireShared(), and sync.

bool tryLock long  timeout,
TimeUnit  unit
[inline]
 

Acquires the shared lock if it is not held exclusively by another thread within the given waiting time.

Acquires the lock if it is not held exclusively by another thread and returns immediately with the value true. 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 lock is held exclusively by another thread then the current thread becomes disabled for thread scheduling purposes and lies dormant until one of three things happens:

  • The lock is acquired by the current thread; or
  • The specified waiting time elapses

If the lock is acquired then the value true is returned.

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.

Parameters:
timeout the time to wait for the lock @param unit the time unit of the timeout argument
Returns:
true if the lock was acquired.

Reimplemented from Lock.

Definition at line 510 of file ReadWriteLock.d.

References sync, toNanos(), and AbstractLock::tryAcquireSharedNanos().

void unlock  )  [inline]
 

Attempts to release this lock.

If the number of readers is now zero then the lock is made available for other lock attempts.

Reimplemented from Lock.

Definition at line 520 of file ReadWriteLock.d.

References AbstractLock::releaseShared(), and sync.

Condition newCondition  )  [inline]
 

Throws UnsupportedOperationException because ReadLocks do not support conditions.

Exceptions:
UnsupportedOperationException always

Reimplemented from Lock.

Definition at line 529 of file ReadWriteLock.d.

char [] toString  )  [inline]
 

Returns a string identifying this lock, as well as its lock state. The state, in brackets, includes the String "Read locks =" followed by the number of held read locks.

Returns:
a string identifying this lock, as well as its lock state.

Definition at line 541 of file ReadWriteLock.d.

References ReentrantReadWriteLock::Sync::getReadLockCount(), and sync.


Member Data Documentation

Sync sync [private]
 

Definition at line 421 of file ReadWriteLock.d.

Referenced by lock(), this(), toString(), tryLock(), and unlock().


The documentation for this class was generated from the following file:
Generated on Mon Nov 14 11:00:00 2005 for Mango by  doxygen 1.4.0