godot/doc/classes/Semaphore.xml

32 lines
1001 B
XML
Raw Normal View History

<?xml version="1.0" encoding="UTF-8" ?>
2018-07-31 18:13:10 +00:00
<class name="Semaphore" inherits="Reference" category="Core" version="3.0.7">
<brief_description>
A synchronization Semaphore.
</brief_description>
<description>
2017-12-22 15:55:18 +00:00
A synchronization Semaphore. Element used to synchronize multiple [Thread]s. Initialized to zero on creation. Be careful to avoid deadlocks. For a binary version, see [Mutex].
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="post">
<return type="int" enum="Error">
</return>
<description>
2017-12-22 15:55:18 +00:00
Lowers the [code]Semaphore[/code], allowing one more thread in. Returns [OK] on success, [ERR_BUSY] otherwise.
</description>
</method>
<method name="wait">
<return type="int" enum="Error">
</return>
<description>
2017-12-22 15:55:18 +00:00
Tries to wait for the [code]Semaphore[/code], if its value is zero, blocks until non-zero. Returns [OK] on success, [ERR_BUSY] otherwise.
</description>
</method>
</methods>
<constants>
</constants>
</class>