2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
2019-04-01 18:33:56 +08:00
<class name= "Semaphore" inherits= "Reference" category= "Core" version= "3.2" >
2017-09-13 04:42:36 +08:00
<brief_description >
2019-06-22 07:04:47 +08:00
A synchronization semaphore.
2017-09-13 04:42:36 +08:00
</brief_description>
<description >
2019-06-22 07:04:47 +08:00
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].
2017-09-13 04:42:36 +08:00
</description>
<tutorials >
</tutorials>
<methods >
<method name= "post" >
<return type= "int" enum= "Error" >
</return>
<description >
2019-06-27 18:34:26 +08:00
Lowers the [Semaphore], allowing one more thread in. Returns [constant OK] on success, [constant ERR_BUSY] otherwise.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "wait" >
<return type= "int" enum= "Error" >
</return>
<description >
2019-06-27 18:34:26 +08:00
Tries to wait for the [Semaphore], if its value is zero, blocks until non-zero. Returns [constant OK] on success, [constant ERR_BUSY] otherwise.
2017-09-13 04:42:36 +08:00
</description>
</method>
</methods>
<constants >
</constants>
</class>
