virtualx-engine/doc/classes/Semaphore.xml
2017-11-24 09:16:52 +01:00

31 lines
830 B
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Semaphore" inherits="Reference" category="Core" version="3.0-beta">
<brief_description>
A synchronization Semaphore.
</brief_description>
<description>
A synchronization Semaphore. Element used in multi-threadding. Initialized to zero on creation.
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="post">
<return type="int" enum="Error">
</return>
<description>
Lowers the [code]Semaphore[/code], allowing one more thread in.
</description>
</method>
<method name="wait">
<return type="int" enum="Error">
</return>
<description>
Tries to wait for the [code]Semaphore[/code], if its value is zero, blocks until non-zero.
</description>
</method>
</methods>
<constants>
</constants>
</class>