Package io.openems.common.utils

Class Mutex

java.lang.Object

io.openems.common.utils.Mutex

public class Mutex
extends Object

Constructor Summary

Constructors

Constructor	Description
Mutex(boolean initiallyPermitted)

Method Summary

Modifier and Type	Method	Description
void	await()	Wait for a release().
void	awaitOrTimeout(long timeout, TimeUnit unit)	Wait for a release() with a timeout.
void	release()	Release the Mutex.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Mutex

public Mutex(boolean initiallyPermitted)

Method Details

await

public void await()
           throws InterruptedException

Wait for a release().

Throws:

InterruptedException - on wait error

awaitOrTimeout

public void awaitOrTimeout(long timeout,
 TimeUnit unit)
                    throws InterruptedException

Wait for a release() with a timeout.

Parameters:

timeout - the timeout value

unit - the timeout TimeUnit

Throws:

InterruptedException - on wait error

release

public void release()

Release the Mutex.