Created
February 4, 2019 12:49
-
-
Save hageldave/2dca5877552f926050bbb26b3fed2324 to your computer and use it in GitHub Desktop.
Semaphore with guaranteed release (even in case of exception) leveraging try with resources
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
import java.util.concurrent.Semaphore; | |
import java.util.concurrent.atomic.AtomicBoolean; | |
/** | |
* This class is a utility class for exception safe usage of a semaphore. | |
* When returns {@code semaphore.acquire() } the current thread successfully entered the | |
* critical region but it has to call {@code semaphore.release() } on exit to make room | |
* for other threads to enter the critical region. | |
* If this call is not guaranteed, thread starvation can occur (or even deadlock) since | |
* threads trying to acquire will wait forever. | |
* | |
* This class solves this problem by returning an {@link AutoCloseable} object on entering | |
* the critical region which calls {@code semaphore.release() } on close. | |
* Using this in conjunction with a try with resources statement guarantees close() to be called. | |
* | |
* Example: | |
* <pre> | |
* CriticalRegion criticalRegion = new CriticalRegion(4); | |
* try( Permit permit = criticalRegion.enter() ) { | |
* // do critical things here .. | |
* } catch (InterruptedException e) { | |
* System.err.println("Thread interrupted before permit into critical region was acquired"); | |
* e.printStackTrace(); | |
* } | |
* </pre> | |
* @author hageldave | |
*/ | |
public class CriticalRegion { | |
private Semaphore semaphore; | |
/** | |
* Creates a CriticalRegion with the specified number of permits, and fair 'entrance' into the region. | |
* See {@link Semaphore#Semaphore(int)} for the exact meaning of this parameter. | |
* @param numPermits num of concurrent threads that can enter the region simultaneously. | |
*/ | |
public CriticalRegion(int numPermits) { | |
semaphore = new Semaphore(numPermits, true); | |
} | |
/** | |
* Attempts entering the critical region, blocking until entered. | |
* @return Permit (use this as a resource in try with resources statement) | |
* @throws InterruptedException if the current thread is interrupted | |
*/ | |
public Permit enter() throws InterruptedException { | |
return new Permit(); | |
} | |
/** | |
* {@link AutoCloseable} that calls {@code semaphore.release() } on close. | |
* This is acquired through {@link CriticalRegion#enter()} | |
* @author haegele | |
*/ | |
public class Permit implements AutoCloseable { | |
private AtomicBoolean isClosed = new AtomicBoolean(false); | |
private Permit() throws InterruptedException { | |
semaphore.acquire(); | |
} | |
@Override | |
public void close() { | |
if(isClosed.compareAndSet(false, true)) | |
semaphore.release(); | |
} | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment