Attention: Here be dragons
This is thelatest (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...
Semaphore
Inherits:RefCounted<Object
A synchronization mechanism used to control access to a shared resource byThreads.
Description
A synchronization semaphore that can be used to synchronize multipleThreads. Initialized to zero on creation. For a binary version, seeMutex.
Warning: Semaphores must be used carefully to avoid deadlocks.
Warning: To guarantee that the operating system is able to perform proper cleanup (no crashes, no deadlocks), these conditions must be met:
When aSemaphore's reference count reaches zero and it is therefore destroyed, no threads must be waiting on it.
When aThread's reference count reaches zero and it is therefore destroyed, it must not be waiting on any semaphore.
Tutorials
Methods
try_wait() | |
wait() |
Method Descriptions
voidpost(count:int = 1)🔗
Lowers theSemaphore, allowing one thread in, or more ifcount is specified.
Likewait(), but won't block, so if the value is zero, fails immediately and returnsfalse. If non-zero, it returnstrue to report success.
Waits for theSemaphore, if its value is zero, blocks until non-zero.