Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
Mutex
Hérite de : RefCounted < Object
Un Semaphore binaire pour la synchronisation de plusieurs Threads.
Description
A synchronization mutex (mutual exclusion). This is used to synchronize multiple Threads, and is equivalent to a binary Semaphore. It guarantees that only one thread can access a critical section at a time.
This is a reentrant mutex, meaning that it can be locked multiple times by one thread, provided it also unlocks it as many times.
Warning: To ensure proper cleanup without crashes or deadlocks, the following conditions must be met:
When a Mutex's reference count reaches zero and it is therefore destroyed, no threads (including the one on which the destruction will happen) must have it locked.
When a Thread's reference count reaches zero and it is therefore destroyed, it must not have any mutex locked.
Tutoriels
Méthodes
void |
lock() |
try_lock() |
|
void |
unlock() |
Descriptions des méthodes
void lock() 🔗
Verrouille ce Mutex, le bloque jusqu'à ce qu'il soit déverrouillé par le propriétaire actuel.
Note : Cette fonction renvoie sans bloquer si ce thread est déjà le propriétaire du mutex.
Essaie de verrouiller ce Mutex, mais ne le bloque pas. Renvoie true en cas de succès, false sinon.
Note : Cette fonction renvoie true si le thread possède déjà le mutex.
void unlock() 🔗
Unlocks this Mutex, leaving it to other threads.
Note: If a thread called lock() or try_lock() multiple times while already having ownership of the mutex, it must also call unlock() the same number of times in order to unlock it correctly.
Warning: Calling unlock() more times than lock() on a given thread, thus ending up trying to unlock a non-locked mutex, is wrong and may causes crashes or deadlocks.