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= "Mutex" inherits= "Reference" category= "Core" version= "3.2" >
2017-09-13 04:42:36 +08:00
<brief_description >
A synchronization Mutex.
</brief_description>
<description >
2017-12-22 23:46:09 +08:00
A synchronization Mutex. Element used to synchronize multiple [Thread]s. Basically a binary [Semaphore]. Guarantees that only one thread can ever acquire this lock at a time. Can be used to protect a critical section. Be careful to avoid deadlocks.
2017-09-13 04:42:36 +08:00
</description>
<tutorials >
</tutorials>
<methods >
<method name= "lock" >
<return type= "void" >
</return>
<description >
2019-03-30 06:37:35 +08:00
Lock this [Mutex], blocks until it is unlocked by the current owner.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "try_lock" >
<return type= "int" enum= "Error" >
</return>
<description >
2019-06-27 18:34:26 +08:00
Try locking this [Mutex], does not block. Returns [constant OK] on success, [constant ERR_BUSY] otherwise.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "unlock" >
<return type= "void" >
</return>
<description >
2019-03-30 06:37:35 +08:00
Unlock this [Mutex], leaving it to other threads.
2017-09-13 04:42:36 +08:00
</description>
</method>
</methods>
<constants >
</constants>
</class>
