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

ReentrantReadWriteLock::WriteLock Class Reference

Inheritance diagram for ReentrantReadWriteLock::WriteLock:

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

final Sync sync

Detailed Description

The lock returned by method ReentrantReadWriteLock.writeLock

Definition at line 554 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 561 of file ReadWriteLock.d.

References lock(), and sync.

void lock  )  [inline]
 

Acquire the 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.

Reimplemented from Lock.

Definition at line 581 of file ReadWriteLock.d.

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

Referenced by this().

bool tryLock  )  [inline]
 

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

Acquires the lock if it is not held by another thread and returns immediately with the value 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.

If the lock is held by another thread then this method will return immediately with the value false.

Returns:
true if the lock was free and was acquired by the current thread, or the lock was already held by the current thread; and false otherwise.

Reimplemented from Lock.

Definition at line 612 of file ReadWriteLock.d.

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

bool tryLock long  timeout,
TimeUnit  unit
[inline]
 

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

Acquires the lock if it is not held by another thread and returns immediately with the value 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.

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:

  • 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 and the lock hold count is set to one.

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
unit the time unit of the timeout argument
Returns:
true if the lock was free and was acquired by the current thread, or the lock was already held by the current thread; and false if the waiting time elapsed before the lock could be acquired.

Reimplemented from Lock.

Definition at line 661 of file ReadWriteLock.d.

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

void unlock  )  [inline]
 

Attempts to release this lock.

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.

Reimplemented from Lock.

Definition at line 672 of file ReadWriteLock.d.

References AbstractLock::release(), and sync.

Condition newCondition  )  [inline]
 

Returns a Condition instance for use with this Lock instance. The semantics are like the semantics of the Condition for a ReentrantLock.

Returns:
the Condition object

Reimplemented from Lock.

Definition at line 682 of file ReadWriteLock.d.

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

char [] toString  )  [inline]
 

Returns a string identifying this lock, as well as its lock state. The state, in brackets includes either the String "Unlocked" or the String "Locked by" followed by the Thread.toString of the owning thread.

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

Definition at line 693 of file ReadWriteLock.d.

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


Member Data Documentation

final Sync sync [private]
 

Definition at line 555 of file ReadWriteLock.d.

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


The documentation for this class was generated from the following file:
Generated on Sat Dec 24 17:28:41 2005 for Mango by  doxygen 1.4.0