info.aduna.concurrent.locks

Class WritePrefReadWriteLockManager

java.lang.Object

info.aduna.concurrent.locks.AbstractReadWriteLockManager

info.aduna.concurrent.locks.WritePrefReadWriteLockManager

All Implemented Interfaces:

ReadWriteLockManager

public class WritePrefReadWriteLockManager
extends AbstractReadWriteLockManager

A read/write lock manager with writer preference. As soon as a write lock is requested, this lock manager will block any read lock requests until the writer's request has been satisfied.

Author:

Arjohn Kampman, James Leigh

Constructor Summary

Constructors

Constructor and Description
WritePrefReadWriteLockManager() Creates a MultiReadSingleWriteLockManager.
WritePrefReadWriteLockManager(boolean trackLocks) Creates a new MultiReadSingleWriteLockManager, optionally with lock tracking enabled.

Method Summary

Methods

Modifier and Type	Method and Description
Lock	getReadLock() Gets a read lock.
Lock	getWriteLock() Gets an exclusive write lock.
Lock	tryReadLock() Gets a read lock, if available.
Lock	tryWriteLock() Gets an exclusive write lock, if available.

Methods inherited from class info.aduna.concurrent.locks.AbstractReadWriteLockManager

createReadLock, createWriteLock, isReaderActive, isWriterActive, waitForActiveReaders, waitForActiveWriter

Methods inherited from class java.lang.Object

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

Constructor Detail

WritePrefReadWriteLockManager

public WritePrefReadWriteLockManager()

Creates a MultiReadSingleWriteLockManager.

WritePrefReadWriteLockManager

public WritePrefReadWriteLockManager(boolean trackLocks)

Creates a new MultiReadSingleWriteLockManager, optionally with lock tracking enabled.

Parameters:

trackLocks - Controls whether the lock manager will keep track of active locks. Enabling lock tracking will add some overhead, but can be very useful for debugging.

Method Detail

tryReadLock

public Lock tryReadLock()

Gets a read lock, if available. This method will return null if the read lock is not immediately available.

getReadLock

public Lock getReadLock()
                 throws InterruptedException

Gets a read lock. This method blocks when a write lock is in use or has been requested until the write lock is released.

Throws:

InterruptedException - In case the thread requesting the lock was interrupted.

tryWriteLock

public Lock tryWriteLock()

Gets an exclusive write lock, if available. This method will return null if the write lock is not immediately available.

getWriteLock

public Lock getWriteLock()
                  throws InterruptedException

Gets an exclusive write lock. This method blocks when the write lock is in use or has already been requested until the write lock is released. This method also block when read locks are active until all of them are released.

Throws:

InterruptedException - In case the thread requesting the lock was interrupted.