Module com.github.stephengold.joltjni

Package com.github.stephengold.joltjni

Class Mutex

java.lang.Object

com.github.stephengold.joltjni.JoltPhysicsObject

com.github.stephengold.joltjni.Mutex

All Implemented Interfaces:

ConstJoltPhysicsObject, AutoCloseable, Comparable<JoltPhysicsObject>

public class Mutex
extends JoltPhysicsObject

Protect shared data from being accessed simultaneously by multiple threads.

Constructor Summary

Constructors

Constructor	Description
Mutex()	Instantiate a mutex.

Method Summary

Modifier and Type	Method	Description
void	lock()	Acquire the mutex.
boolean	tryLock()	Attempt to acquire the mutex and immediately return false if it's unavailable.
void	unlock()	Release the mutex.

Methods inherited from class com.github.stephengold.joltjni.JoltPhysicsObject

close, compareTo, equals, getContainingObject, hasAssignedNativeObject, hashCode, ownsNativeObject, setVirtualAddress, setVirtualAddress, startCleaner, targetVa, toString, va

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Mutex

public Mutex()

Instantiate a mutex.

Method Details

lock

public void lock()

Acquire the mutex.

tryLock

public boolean tryLock()

Attempt to acquire the mutex and immediately return false if it's unavailable.

Returns:

true if acquired, otherwise false

unlock

public void unlock()

Release the mutex.