mirror of
https://github.com/godotengine/godot.git
synced 2024-11-27 09:16:35 +08:00
b68dd2e189
This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
33 lines
1.2 KiB
XML
33 lines
1.2 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="Semaphore" inherits="RefCounted" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<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>
|
|
<method name="try_wait">
|
|
<return type="int" enum="Error" />
|
|
<description>
|
|
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>
|
|
<method name="wait">
|
|
<return type="void" />
|
|
<description>
|
|
Waits for the [Semaphore], if its value is zero, blocks until non-zero.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
</class>
|