com.sleepycat.je.latch
Interface Latch

All Known Implementing Classes:
Java5LatchImpl, LatchImpl

public interface Latch


Method Summary
 void acquire()
          Acquire a latch for exclusive/write access.
 boolean acquireNoWait()
          Acquire a latch for exclusive/write access, but do not block if it's not available.
 LatchStats getLatchStats()
           
 boolean isOwner()
          Return true if the current thread holds this latch.
 int nWaiters()
          Return the number of threads waiting.
 java.lang.Thread owner()
          Used only for unit tests.
 void release()
          Release the latch.
 void releaseIfOwner()
          Release the latch.
 void setName(java.lang.String name)
          Set the latch name, used for latches in objects instantiated from the log.
 java.lang.String toString()
          Formats a latch owner and waiters.
 

Method Detail

setName

void setName(java.lang.String name)
Set the latch name, used for latches in objects instantiated from the log.


acquire

void acquire()
             throws DatabaseException
Acquire a latch for exclusive/write access.

Wait for the latch if some other thread is holding it. If there are threads waiting for access, they will be granted the latch on a FIFO basis. When the method returns, the latch is held for exclusive access.

Throws:
LatchException - if the latch is already held by the calling thread.
RunRecoveryException - if an InterruptedException exception occurs.
DatabaseException

acquireNoWait

boolean acquireNoWait()
                      throws LatchException
Acquire a latch for exclusive/write access, but do not block if it's not available.

Returns:
true if the latch was acquired, false if it is not available.
Throws:
LatchException - if the latch is already held by the calling thread.

releaseIfOwner

void releaseIfOwner()
Release the latch. If there are other thread(s) waiting for the latch, one is woken up and granted the latch. If the latch was not owned by the caller, just return;


release

void release()
             throws LatchNotHeldException
Release the latch. If there are other thread(s) waiting for the latch, they are woken up and granted the latch.

Throws:
LatchNotHeldException - if the latch is not currently held.

isOwner

boolean isOwner()
Return true if the current thread holds this latch.

Returns:
true if we hold this latch. False otherwise.

owner

java.lang.Thread owner()
Used only for unit tests.

Returns:
the thread that currently holds the latch for exclusive access.

nWaiters

int nWaiters()
Return the number of threads waiting.

Returns:
the number of threads waiting for the latch.

getLatchStats

LatchStats getLatchStats()
Returns:
a LatchStats object with information about this latch.

toString

java.lang.String toString()
Formats a latch owner and waiters.

Overrides:
toString in class java.lang.Object


Copyright 2004,2008 Oracle. All rights reserved.