Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.util
Class Semaphore

java.lang.Object
  extended by com.jivesoftware.util.Semaphore

public class Semaphore
extends java.lang.Object

Base class for counting semaphores. Conceptually, a semaphore maintains a set of permits. Each acquire() blocks if necessary until a permit is available, and then takes it. Each release adds a permit. However, no actual permit objects are used; the Semaphore just keeps a count of the number available and acts accordingly.

A semaphore initialized to 1 can serve as a mutual exclusion lock.

Different implementation subclasses may provide different ordering guarantees (or lack thereof) surrounding which threads will be resumed upon a signal.

The default implementation makes NO guarantees about the order in which threads will acquire permits. It is often faster than other implementations.


Field Summary
protected  long permits
          current number of available permits
 
Constructor Summary
Semaphore(long initialPermits)
          Create a Semaphore with the given initial number of permits.
 
Method Summary
 void acquire()
          Wait until a permit is available, and take one
 boolean attempt(long msecs)
          Wait at most msecs millisconds for a permit.
 long permits()
          Return the current number of available permits.
 void release()
          Release a permit
 void release(long n)
          Release N permits.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

permits

protected long permits
current number of available permits

Constructor Detail

Semaphore

public Semaphore(long initialPermits)
Create a Semaphore with the given initial number of permits. Using a seed of one makes the semaphore act as a mutual exclusion lock. Negative seeds are also allowed, in which case no acquires will proceed until the number of releases has pushed the number of permits past 0.

Method Detail

acquire

public void acquire()
             throws java.lang.InterruptedException
Wait until a permit is available, and take one

Throws:
java.lang.InterruptedException

attempt

public boolean attempt(long msecs)
                throws java.lang.InterruptedException
Wait at most msecs millisconds for a permit.

Throws:
java.lang.InterruptedException

release

public void release()
Release a permit


release

public void release(long n)
Release N permits. release(n) is equivalent in effect to:
   for (int i = 0; i < n; ++i) release();
 

But may be more efficient in some semaphore implementations.

Throws:
java.lang.IllegalArgumentException - if n is negative.

permits

public long permits()
Return the current number of available permits. Returns an accurate, but possibly unstable value, that may change immediately after returning.


Jive Forums Project Page

Copyright © 1999-2006 Jive Software.