2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name= "Mutex" inherits= "Reference" category= "Core" version= "3.0.alpha.custom_build" >
<brief_description >
A synchronization Mutex.
</brief_description>
<description >
A synchronization Mutex. Element used in multi-threadding. Basically a binary [Semaphore]. Guarantees that only one thread has this lock, can be used to protect a critical section.
</description>
<tutorials >
</tutorials>
<demos >
</demos>
<methods >
<method name= "lock" >
<return type= "void" >
</return>
<description >
2017-10-22 10:56:11 +00:00
Lock this [code]Mutex[/code], blocks until it is unlocked by the current owner.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "try_lock" >
<return type= "int" enum= "Error" >
</return>
<description >
2017-10-22 10:56:11 +00:00
Try locking this [code]Mutex[/code], does not block. Returns [OK] on success else [ERR_BUSY].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "unlock" >
<return type= "void" >
</return>
<description >
2017-10-22 10:56:11 +00:00
Unlock this [code]Mutex[/code], leaving it to others threads.
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
<constants >
</constants>
</class>