blob: aa87f839be5b8b8466267e1b24129fd788153110 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
|
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Mutex" inherits="Reference" category="Core" version="3.0-rc1">
<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 [code]Mutex[/code], 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 [code]Mutex[/code], does not block. Returns [OK] on success, [ERR_BUSY] otherwise.
</description>
</method>
<method name="unlock">
<return type="void">
</return>
<description>
Unlock this [code]Mutex[/code], leaving it to other threads.
</description>
</method>
</methods>
<constants>
</constants>
</class>
|