| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647 |
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the Semaphore.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_Semaphore:
- Semaphore
- =========
- **Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
- **Category:** Core
- Brief Description
- -----------------
- A synchronization Semaphore.
- Methods
- -------
- +---------------------------------------+------------------------------------------------------+
- | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`post<class_Semaphore_method_post>` **(** **)** |
- +---------------------------------------+------------------------------------------------------+
- | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`wait<class_Semaphore_method_wait>` **(** **)** |
- +---------------------------------------+------------------------------------------------------+
- Description
- -----------
- A synchronization Semaphore. Element used to synchronize multiple :ref:`Thread<class_Thread>`\ s. Initialized to zero on creation. Be careful to avoid deadlocks. For a binary version, see :ref:`Mutex<class_Mutex>`.
- Method Descriptions
- -------------------
- .. _class_Semaphore_method_post:
- - :ref:`Error<enum_@GlobalScope_Error>` **post** **(** **)**
- Lowers the ``Semaphore``, allowing one more thread in. Returns ``OK`` on success, ``ERR_BUSY`` otherwise.
- .. _class_Semaphore_method_wait:
- - :ref:`Error<enum_@GlobalScope_Error>` **wait** **(** **)**
- Tries to wait for the ``Semaphore``, if its value is zero, blocks until non-zero. Returns ``OK`` on success, ``ERR_BUSY`` otherwise.
|
