godot-docs/classes/class_mutex.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Mutex.xml.

.. _class_Mutex:

Mutex
=====

**Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`

A synchronization mutex (mutual exclusion).

Description
-----------

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.

Tutorials
---------

- :doc:`Using multiple threads <../tutorials/performance/using_multiple_threads>`

Methods
-------

+---------------------------------------+----------------------------------------------------------+
| void                                  | :ref:`lock<class_Mutex_method_lock>` **(** **)**         |
+---------------------------------------+----------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`try_lock<class_Mutex_method_try_lock>` **(** **)** |
+---------------------------------------+----------------------------------------------------------+
| void                                  | :ref:`unlock<class_Mutex_method_unlock>` **(** **)**     |
+---------------------------------------+----------------------------------------------------------+

Method Descriptions
-------------------

.. _class_Mutex_method_lock:

- void **lock** **(** **)**

Locks this ``Mutex``, blocks until it is unlocked by the current owner.

\ **Note:** This function returns without blocking if the thread already has ownership of the mutex.

----

.. _class_Mutex_method_try_lock:

- :ref:`Error<enum_@GlobalScope_Error>` **try_lock** **(** **)**

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.

\ **Note:** This function returns :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` if the thread already has ownership of the mutex.

----

.. _class_Mutex_method_unlock:

- void **unlock** **(** **)**

Unlocks this ``Mutex``, leaving it to other threads.

\ **Note:** If a thread called :ref:`lock<class_Mutex_method_lock>` or :ref:`try_lock<class_Mutex_method_try_lock>` multiple times while already having ownership of the mutex, it must also call :ref:`unlock<class_Mutex_method_unlock>` the same number of times in order to unlock it correctly.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`