org.apache.curator.framework.recipes.locks
Class InterProcessReadWriteLock

java.lang.Object
  org.apache.curator.framework.recipes.locks.InterProcessReadWriteLock

public class InterProcessReadWriteLock
extends Object

A re-entrant read/write mutex that works across JVMs. Uses Zookeeper to hold the lock. All processes in all JVMs that use the same lock path will achieve an inter-process critical section. Further, this mutex is "fair" - each user will get the mutex in the order requested (from ZK's point of view).

A read write lock maintains a pair of associated locks, one for read-only operations and one for writing. The read lock may be held simultaneously by multiple reader processes, so long as there are no writers. The write lock is exclusive.

Reentrancy
This lock allows both readers and writers to reacquire read or write locks in the style of a re-entrant lock. Non-re-entrant readers are not allowed until all write locks held by the writing thread/process have been released. Additionally, a writer can acquire the read lock, but not vice-versa. If a reader tries to acquire the write lock it will never succeed.

Lock downgrading
Re-entrancy also allows downgrading from the write lock to a read lock, by acquiring the write lock, then the read lock and then releasing the write lock. However, upgrading from a read lock to the write lock is not possible.

Constructor Summary

InterProcessReadWriteLock(org.apache.curator.framework.CuratorFramework client, String basePath)

Method Summary

InterProcessMutex	readLock() Returns the lock used for reading.
InterProcessMutex	writeLock() Returns the lock used for writing.

Methods inherited from class java.lang.Object

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

Constructor Detail

InterProcessReadWriteLock

public InterProcessReadWriteLock(org.apache.curator.framework.CuratorFramework client,
                                 String basePath)

Parameters:

client - the client

basePath - path to use for locking

Method Detail

readLock

public InterProcessMutex readLock()

Returns the lock used for reading.

Returns:

read lock

writeLock

public InterProcessMutex writeLock()

Returns the lock used for writing.

Returns:

write lock