io.humble.ferry

Class Mutex

java.lang.Object

io.humble.ferry.RefCounted

io.humble.ferry.Mutex

public class Mutex
extends RefCounted

Internal Only.

This object exists so that Native code can get access to
thread safe locking objects if they need it.

Implements a blocking Mutually-Exclusive lock
by wrapping a Java lock.

If not running inside Java, lock() and unlock()
are NO-OPs.

Method Summary

Modifier and Type	Method and Description
Mutex	copyReference() Create a new Mutex object that is actually referring to the exact same underlying native object.
boolean	equals(Object obj) Compares two values, returning true if the underlying objects in native code are the same object.
int	hashCode() Get a hashable value for this object.
void	lock()
static Mutex	make()
void	unlock()

Methods inherited from class io.humble.ferry.RefCounted

delete, getCurrentRefCount

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

copyReference

public Mutex copyReference()

Create a new Mutex object that is actually referring to the exact same underlying native object.

Overrides:

copyReference in class RefCounted

Returns:

the new Java object.

equals

public boolean equals(Object obj)

Compares two values, returning true if the underlying objects in native code are the same object. That means you can have two different Java objects, but when you do a comparison, you'll find out they are the EXACT same object.

Overrides:

equals in class Object

Returns:

True if the underlying native object is the same. False otherwise.

hashCode

public int hashCode()

Get a hashable value for this object.

Overrides:

hashCode in class Object

Returns:

the hashable value.

make

public static Mutex make()

lock

public void lock()

unlock

public void unlock()