diff options
| author | Pedro J. Estébanez <pedrojrulez@gmail.com> | 2023-01-28 13:34:06 +0100 |
|---|---|---|
| committer | Pedro J. Estébanez <pedrojrulez@gmail.com> | 2023-05-12 19:04:57 +0200 |
| commit | 6189ab5291e54dfe090a081cf292e3d6f9c6b8b1 (patch) | |
| tree | b8981fc927de9068a6e3dfb4df2ad70f47c44fa5 /doc/classes/Thread.xml | |
| parent | 20ed51a9129f97bb8d001262155fb3ccfc1e3c89 (diff) | |
| download | redot-engine-6189ab5291e54dfe090a081cf292e3d6f9c6b8b1.tar.gz | |
Robustify multi-threading primitives
Diffstat (limited to 'doc/classes/Thread.xml')
| -rw-r--r-- | doc/classes/Thread.xml | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/classes/Thread.xml b/doc/classes/Thread.xml index 2b4ef65f0c..fcb803b15a 100644 --- a/doc/classes/Thread.xml +++ b/doc/classes/Thread.xml @@ -6,6 +6,11 @@ <description> A unit of execution in a process. Can run methods on [Object]s simultaneously. The use of synchronization via [Mutex] or [Semaphore] is advised if working with shared objects. [b]Note:[/b] Breakpoints won't break on code if it's running in a thread. This is a current limitation of the GDScript debugger. + [b]Warning:[/b] + To guarantee that the operating system is able to perform proper cleanup (no crashes, no deadlocks), these conditions must be met by the time a [Thread]'s reference count reaches zero and therefore it is destroyed: + - It must not have any [Mutex] objects locked. + - It must not be waiting on any [Semaphore] objects. + - [method wait_to_finish] should have been called on it. </description> <tutorials> <link title="Using multiple threads">$DOCS_URL/tutorials/performance/using_multiple_threads.html</link> |