Fix a typo in "Using multiple threads"

"us unlocked" -> "is unlocked"
This commit is contained in:
Hugo Locurcio
2019-07-14 20:06:43 +02:00
parent 305b71c999
commit 41c8ea71e0

View File

@@ -6,11 +6,13 @@ Using multiple threads
Threads
-------
Threads allow simultaneous execution of code. It allows off-loading work from the main thread.
Threads allow simultaneous execution of code. It allows off-loading work
from the main thread.
Godot supports threads and provides many handy functions to use them.
.. note:: If using other languages (C#, C++), it may be easier to use the threading classes they support.
.. note:: If using other languages (C#, C++), it may be easier to use the
threading classes they support.
Creating a Thread
-----------------
@@ -42,8 +44,8 @@ Creating a thread is very simple, just use the following code:
Your function will, then, run in a separate thread until it returns.
Even if the function has returned already, the thread must collect it, so call
:ref:`Thread.wait_to_finish()<class_Thread_method_wait_to_finish>`, which will wait until the
thread is done (if not done yet), then properly dispose of it.
:ref:`Thread.wait_to_finish()<class_Thread_method_wait_to_finish>`, which will
wait until the thread is done (if not done yet), then properly dispose of it.
Mutexes
-------
@@ -52,12 +54,17 @@ Accessing objects or data from multiple threads is not always supported (if you
cause unexpected behaviors or crashes). Read the :ref:`Thread safe APIs<doc_thread_safe_apis>`
to understand which engine APIs support multiple thread access.
When processing your own data or calling your own functions, as a rule, try to avoid accessing
the same data directly from different threads. You may run into synchronization problems, as the
data is not always updated between CPU cores when modified.
Always use a :ref:`Mutex<class_Mutex>` when accessing a piece of data from different threads.
When processing your own data or calling your own functions, as a rule, try to
avoid accessing the same data directly from different threads. You may run into
synchronization problems, as the data is not always updated between CPU cores
when modified. Always use a :ref:`Mutex<class_Mutex>` when accessing
a piece of data from different threads.
When calling :ref:`Mutex.lock()<class_Mutex_method_lock>`, a thread ensures that all other threads will be blocked (put on suspended state) if they try to *lock* the same mutex. When the mutex us unlocked by calling :ref:`Mutex.unlock()<class_Mutex_method_unlock>`, the other threads will be allowed to proceed with the lock (but only one at a time).
When calling :ref:`Mutex.lock()<class_Mutex_method_lock>`, a thread ensures that
all other threads will be blocked (put on suspended state) if they try to *lock*
the same mutex. When the mutex is unlocked by calling
:ref:`Mutex.unlock()<class_Mutex_method_unlock>`, the other threads will be
allowed to proceed with the lock (but only one at a time).
Here is an example of using a Mutex:
@@ -73,7 +80,7 @@ Here is an example of using a Mutex:
mutex = Mutex.new()
thread = Thread.new()
thread.start(self, "_thread_function")
# Increase value, protect it with Mutex.
mutex.lock()
counter += 1
@@ -93,12 +100,15 @@ Here is an example of using a Mutex:
Semaphores
----------
Sometimes you want your thread to work *"on demand"*. In other words, tell it when to work
and let it suspend when it isn't doing anything.
For this :ref:`Semaphores<class_Semaphore>` are used. The function :ref:`Semaphore.wait()<class_Semaphore_method_wait>`
is used in the thread to suspend it until some data arrives.
Sometimes you want your thread to work *"on demand"*. In other words, tell it
when to work and let it suspend when it isn't doing anything.
For this, :ref:`Semaphores<class_Semaphore>` are used. The function
:ref:`Semaphore.wait()<class_Semaphore_method_wait>` is used in the thread to
suspend it until some data arrives.
The main thread, instead, uses :ref:`Semaphore.post()<class_Semaphore_method_post>` to signal that data is ready to be processed:
The main thread, instead, uses
:ref:`Semaphore.post()<class_Semaphore_method_post>` to signal that data is
ready to be processed:
.. tabs::
.. code-tab:: gdscript GDScript