<?xml version="1.0" encoding="UTF-8" ?> <class name="Mutex" inherits="Reference" category="Core" version="3.2"> <brief_description> A synchronization Mutex. </brief_description> <description> 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. </description> <tutorials> </tutorials> <demos> </demos> <methods> <method name="lock"> <return type="void"> </return> <description> Lock this [Mutex], blocks until it is unlocked by the current owner. </description> </method> <method name="try_lock"> <return type="int" enum="Error"> </return> <description> Try locking this [Mutex], does not block. Returns [code]OK[/code] on success, [code]ERR_BUSY[/code] otherwise. </description> </method> <method name="unlock"> <return type="void"> </return> <description> Unlock this [Mutex], leaving it to other threads. </description> </method> </methods> <constants> </constants> </class>