2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2019-07-05 11:32:53 +02:00
<class name= "Mutex" inherits= "Reference" category= "Core" version= "3.1.2" >
2017-09-12 22:42:36 +02:00
<brief_description >
A synchronization Mutex.
</brief_description>
<description >
2017-12-22 16:46:09 +01: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-12 22:42:36 +02:00
</description>
<tutorials >
</tutorials>
<methods >
<method name= "lock" >
<return type= "void" >
</return>
<description >
2017-10-22 12:56:11 +02:00
Lock this [code]Mutex[/code], blocks until it is unlocked by the current owner.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "try_lock" >
<return type= "int" enum= "Error" >
</return>
<description >
2019-01-07 10:02:04 +01:00
Try locking this [code]Mutex[/code], does not block. Returns [code]OK[/code] on success, [code]ERR_BUSY[/code] otherwise.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "unlock" >
<return type= "void" >
</return>
<description >
2017-12-22 16:46:09 +01:00
Unlock this [code]Mutex[/code], leaving it to other threads.
2017-09-12 22:42:36 +02:00
</description>
</method>
</methods>
<constants >
</constants>
</class>