godot/doc/classes/Mutex.xml
2021-08-12 17:08:10 +02:00

35 lines
1.2 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Mutex" inherits="Reference" version="3.4">
<brief_description>
A synchronization mutex (mutual exclusion).
</brief_description>
<description>
A synchronization mutex (mutual exclusion). This is used to synchronize multiple [Thread]s, and is equivalent to a binary [Semaphore]. It guarantees that only one thread can ever acquire the lock at a time. A mutex can be used to protect a critical section; however, be careful to avoid deadlocks.
</description>
<tutorials>
<link>https://docs.godotengine.org/en/3.4/tutorials/threads/using_multiple_threads.html</link>
</tutorials>
<methods>
<method name="lock">
<return type="void" />
<description>
Locks this [Mutex], blocks until it is unlocked by the current owner.
</description>
</method>
<method name="try_lock">
<return type="int" enum="Error" />
<description>
Tries locking this [Mutex], but does not block. Returns [constant OK] on success, [constant ERR_BUSY] otherwise.
</description>
</method>
<method name="unlock">
<return type="void" />
<description>
Unlocks this [Mutex], leaving it to other threads.
</description>
</method>
</methods>
<constants>
</constants>
</class>