godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

dync classref with current source

Browse Source
This commit is contained in:
Rémi Verschelde
2019-06-29 12:36:34 +02:00
parent 7d1e807f69
commit 05d7b34796
349 changed files with 3655 additions and 2920 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
classes/class_mutex.rst
View File

@@ -14,7 +14,7 @@ Mutex
Brief Description
-----------------
A synchronization Mutex.
A synchronization mutex (mutual exclusion).
Methods
-------
@@ -30,7 +30,7 @@ Methods
Description
-----------
A synchronization Mutex. Element used to synchronize multiple :ref:`Thread<class_Thread>`\ s. Basically a binary :ref:`Semaphore<class_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.
A synchronization mutex (mutual exclusion). This is used to synchronize multiple :ref:`Thread<class_Thread>`\ s, and is equivalent to a binary :ref:`Semaphore<class_Semaphore>`. It guarantees that only one thread can ever acquire the lock at a time. A mutex can be used to protect a critical section; however, be careful to avoid deadlocks.
Method Descriptions
-------------------
@@ -39,17 +39,17 @@ Method Descriptions
- void **lock** **(** **)**
Lock this ``Mutex``, blocks until it is unlocked by the current owner.
Locks this ``Mutex``, blocks until it is unlocked by the current owner.
.. _class_Mutex_method_try_lock:
- :ref:`Error<enum_@GlobalScope_Error>` **try_lock** **(** **)**
Try locking this ``Mutex``, does not block. Returns ``OK`` on success, ``ERR_BUSY`` otherwise.
Tries locking this ``Mutex``, but does not block. Returns :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` on success, :ref:`@GlobalScope.ERR_BUSY<class_@GlobalScope_constant_ERR_BUSY>` otherwise.
.. _class_Mutex_method_unlock:
- void **unlock** **(** **)**
Unlock this ``Mutex``, leaving it to other threads.
Unlocks this ``Mutex``, leaving it to other threads.