Relintai/pandemonium_engine
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine.git synced 2024-12-26 05:37:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fix docs for the write lock part of the RWLock, as it's not re-entrant.

Browse Source
This commit is contained in:
Relintai 2023-07-06 21:46:45 +02:00
parent bbbcfacd84
commit 3244eab5c5
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/classes/RWLock.xml
View File

@ -34,21 +34,20 @@
<return type="void" /> <return type="void" />
<description> <description>
Locks this [RWLock] for write access, blocks until it is unlocked by the current owner. Locks this [RWLock] for write access, 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 rwlock. [b]Note:[/b] This function will deadlock if the thread already has ownership of the rwlock!
</description> </description>
</method> </method>
<method name="write_try_lock"> <method name="write_try_lock">
<return type="int" enum="Error" /> <return type="int" enum="Error" />
<description> <description>
Tries locking this [RWLock] for write access, but does not block. Returns [constant OK] on success, [constant ERR_BUSY] otherwise. Tries locking this [RWLock] for write access, 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 rwlock. [b]Note:[/b] This function returns [constant ERR_BUSY] if the thread already has ownership of the rwlock.
</description> </description>
</method> </method>
<method name="write_unlock"> <method name="write_unlock">
<return type="void" /> <return type="void" />
<description> <description>
Unlocks this [RWLock] for write access, leaving it to other threads. Unlocks this [RWLock] for write access, 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 rwlock, it must also call [method unlock] the same number of times in order to unlock it correctly.
</description> </description>
</method> </method>
</methods> </methods>