Skip to content

Commit

Permalink
Documented that mutexes are implemented recursively
Browse files Browse the repository at this point in the history
  • Loading branch information
mbrlabs committed Mar 3, 2021
1 parent 864caf5 commit 46bbeb2
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions doc/classes/Mutex.xml
Original file line number Diff line number Diff line change
Expand Up @@ -15,20 +15,23 @@
</return>
<description>
Locks this [Mutex], blocks until it is unlocked by the current owner.
[b]Note:[/b] This function returns without blocking if the thread already has ownership of the mutex.
</description>
</method>
<method name="try_lock">
<return type="int" enum="Error">
</return>
<description>
Tries locking this [Mutex], but does not block. Returns [constant OK] on success, [constant ERR_BUSY] otherwise.
[b]Note:[/b] This function returns [constant OK] if the thread already has ownership of the mutex.
</description>
</method>
<method name="unlock">
<return type="void">
</return>
<description>
Unlocks this [Mutex], leaving it to other threads.
[b]Note:[/b] If a thread called [method lock] or [method try_lock] multiple times while already having ownership of the mutex, it must also call [method unlock] the same number of times in order to unlock it correctly.
</description>
</method>
</methods>
Expand Down

0 comments on commit 46bbeb2

Please sign in to comment.