|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface NodeLock
Interface for a lock for nodes.
Nested Class Summary | |
---|---|
static class |
NodeLock.LockType
|
Method Summary | |
---|---|
boolean |
acquire(Object caller,
long timeout,
NodeLock.LockType lock_type)
|
Set<NodeLock> |
acquireAll(Object caller,
long timeout,
NodeLock.LockType lock_type)
Recursively acquire locks for this node and all subnodes, including internal Fqns such as buddy backup subtrees. |
Set<NodeLock> |
acquireAll(Object caller,
long timeout,
NodeLock.LockType lock_type,
boolean excludeInternalFqns)
Same as the overloaded acquire(Object, long, org.jboss.cache.lock.NodeLock.LockType) except that you can
optionally specify that internal Fqns - such as buddy backup subtrees - can be excluded when acquiring locks. |
boolean |
acquireReadLock(Object caller,
long timeout)
Acquires a read lock with a timeout period of timeout milliseconds. |
boolean |
acquireWriteLock(Object caller,
long timeout)
Acquires a write lock with a timeout of timeout milliseconds. |
Fqn |
getFqn()
|
Collection<Object> |
getReaderOwners()
Returns a copy of the reader lock owner in List. |
Object |
getWriterOwner()
Returns the writer lock owner object. |
boolean |
isLocked()
Check if there is a read or write lock |
boolean |
isOwner(Object o)
Returns true if the object is the lock owner. |
boolean |
isReadLocked()
Check if there is a read lock. |
boolean |
isWriteLocked()
Check if there is a write lock. |
void |
printLockInfo(StringBuffer sb,
int indent)
|
void |
release(Object caller)
Releases the lock held by the owner. |
void |
releaseAll()
Releases all locks associated with this instance. |
void |
releaseAll(Object owner)
Releases all locks with this owner. |
Method Detail |
---|
Fqn getFqn()
Collection<Object> getReaderOwners()
Object getWriterOwner()
boolean acquireWriteLock(Object caller, long timeout) throws LockingException, TimeoutException, InterruptedException
timeout
milliseconds.
Note that if the current owner owns a read lock, it will be upgraded
automatically. However, if upgrade fails, i.e., timeout, the read lock will
be released automatically.
caller
- Can't be null.timeout
-
LockingException
TimeoutException
InterruptedException
boolean acquireReadLock(Object caller, long timeout) throws LockingException, TimeoutException, InterruptedException
timeout
milliseconds.
caller
- Can't be null.timeout
-
LockingException
TimeoutException
InterruptedException
void release(Object caller)
caller
- Can't be null.void releaseAll()
void releaseAll(Object owner)
boolean isReadLocked()
boolean isWriteLocked()
boolean isLocked()
boolean isOwner(Object o)
boolean acquire(Object caller, long timeout, NodeLock.LockType lock_type) throws LockingException, TimeoutException, InterruptedException
LockingException
TimeoutException
InterruptedException
Set<NodeLock> acquireAll(Object caller, long timeout, NodeLock.LockType lock_type) throws LockingException, TimeoutException, InterruptedException
caller
- lock ownertimeout
- time to waitlock_type
- type of lock
LockingException
TimeoutException
InterruptedException
Set<NodeLock> acquireAll(Object caller, long timeout, NodeLock.LockType lock_type, boolean excludeInternalFqns) throws LockingException, TimeoutException, InterruptedException
acquire(Object, long, org.jboss.cache.lock.NodeLock.LockType)
except that you can
optionally specify that internal Fqns - such as buddy backup subtrees - can be excluded when acquiring locks.
caller
- lock ownertimeout
- time to waitlock_type
- type of lockexcludeInternalFqns
- if true, locks on internal fqns are not acquired.
LockingException
TimeoutException
InterruptedException
void printLockInfo(StringBuffer sb, int indent)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |