com.github.thorbenkuck.netcom2.interfaces.Mutex Maven / Gradle / Ivy
package com.github.thorbenkuck.netcom2.interfaces;
/**
* This interface provides a mechanism to acquire any Object at runtime to ensure Thread-Safety.
*
* By calling acquire, the object will block any other acquire calls until release is called.
*
* It emulates a {@link java.util.concurrent.Semaphore}. Therefore, it can be realized internally with a Semaphore.
* It encapsulates an Semaphore. Therefore the Synchronization Mechanism can be changed easily.
*
* @version 1.0
* @since 1.0
*/
public interface Mutex {
/**
* Acquires access over the object. If any other Object has access over the given Object, this Methods waits until
* the current owner calls release.
*
* @throws InterruptedException if the waiting takes to long.
*/
void acquire() throws InterruptedException;
/**
* Releases the access over the Object and invoking any waiting Threads.
*/
void release();
}