godot/doc/classes/Semaphore.xml

33 lines
1.1 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="UTF-8" ?>
2021-06-05 00:03:15 +08:00
<class name="Semaphore" inherits="RefCounted" version="4.0">
<brief_description>
A synchronization semaphore.
</brief_description>
<description>
A synchronization semaphore which can be used to synchronize multiple [Thread]s. Initialized to zero on creation. Be careful to avoid deadlocks. For a binary version, see [Mutex].
</description>
<tutorials>
<link title="Using multiple threads">$DOCS_URL/tutorials/performance/using_multiple_threads.html</link>
</tutorials>
<methods>
<method name="post">
<return type="void" />
<description>
Lowers the [Semaphore], allowing one more thread in.
</description>
</method>
2020-03-09 17:12:53 +08:00
<method name="try_wait">
<return type="int" enum="Error" />
<description>
2020-03-09 17:12:53 +08:00
Like [method wait], but won't block, so if the value is zero, fails immediately and returns [constant ERR_BUSY]. If non-zero, it returns [constant OK] to report success.
</description>
</method>
2020-03-09 17:12:53 +08:00
<method name="wait">
<return type="void" />
<description>
2020-03-09 17:12:53 +08:00
Waits for the [Semaphore], if its value is zero, blocks until non-zero.
</description>
</method>
</methods>
</class>