Files
godot-docs/classes/class_semaphore.rst
Rémi Verschelde 1b5e8c18fd classref: Order everything alphabetically
And sync with current 2.0.x sources.
2016-06-25 02:10:54 +02:00

48 lines
1.1 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_Semaphore:
Semaphore
=========
**Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
A synchronization Semaphore.
Member Functions
----------------
+--------+------------------------------------------------+
| Error | :ref:`post<class_Semaphore_post>` **(** **)** |
+--------+------------------------------------------------+
| Error | :ref:`wait<class_Semaphore_wait>` **(** **)** |
+--------+------------------------------------------------+
Description
-----------
A synchronization Semaphore. Element used in multi-threadding. Initialized to zero on creation.
Member Function Description
---------------------------
.. _class_Semaphore_post:
- Error **post** **(** **)**
Lowers the :ref:`Semaphore<class_semaphore>`, allowing one more thread in.
.. _class_Semaphore_wait:
- Error **wait** **(** **)**
Tries to wait for the :ref:`Semaphore<class_semaphore>`, if it's value is zero, blocks until non-zero.