virtualx-engine/doc/classes/Semaphore.xml
Rémi Verschelde fc09e14366 classref: Sync with current source
Also fix hyperlink references to same class as per the guidelines.
[ci skip]
2017-10-22 12:56:17 +02:00

31 lines
844 B
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Semaphore" inherits="Reference" category="Core" version="3.0.alpha.custom_build">
<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>