mirror of
https://github.com/Relintai/pandemonium_engine.git
synced 2024-12-20 19:06:53 +01:00
29 lines
1.0 KiB
XML
29 lines
1.0 KiB
XML
|
<?xml version="1.0" encoding="UTF-8" ?>
|
||
|
|
<class name="Semaphore" inherits="Reference" version="3.5">
|
||
|
|
<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>$DOCS_URL/tutorials/performance/threads/using_multiple_threads.html</link>
|
||
|
|
</tutorials>
|
||
|
|
<methods>
|
||
|
|
<method name="post">
|
||
|
|
<return type="int" enum="Error" />
|
||
|
|
<description>
|
||
|
|
Lowers the [Semaphore], allowing one more thread in. Returns [constant OK] on success, [constant ERR_BUSY] otherwise.
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="wait">
|
||
|
|
<return type="int" enum="Error" />
|
||
|
|
<description>
|
||
|
|
Tries to wait for the [Semaphore], if its value is zero, blocks until non-zero. Returns [constant OK] on success, [constant ERR_BUSY] otherwise.
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
</methods>
|
||
|
|
<constants>
|
||
|
|
</constants>
|
||
|
|
</class>
|