Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: f26bdbbcd4
Branches Tags
godot-docs
/
classes
/
class_semaphore.rst

class_semaphore.rst 2.1 KB
History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the Semaphore.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_Semaphore:
    8. 

  8. 

  9. Semaphore
    10. 

  10. =========
    11. 

  11. 

  12. **Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
    13. 

  13. 

  14. A synchronization semaphore.
    15. 

  15. 

  16. Description
    17. 

  17. -----------
    18. 

  18. 

  19. A synchronization semaphore which can be 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>`.
    20. 

  20. 

  21. Tutorials
    22. 

  22. ---------
    23. 

  23. 

  24. - :doc:`../tutorials/performance/using_multiple_threads`
    25. 

  25. 

  26. Methods
    27. 

  27. -------
    28. 

  28. 

  29. +---------------------------------------+--------------------------------------------------------------+
    30. 

  30. | void                                  | :ref:`post<class_Semaphore_method_post>` **(** **)**         |
    31. 

  31. +---------------------------------------+--------------------------------------------------------------+
    32. 

  32. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`try_wait<class_Semaphore_method_try_wait>` **(** **)** |
    33. 

  33. +---------------------------------------+--------------------------------------------------------------+
    34. 

  34. | void                                  | :ref:`wait<class_Semaphore_method_wait>` **(** **)**         |
    35. 

  35. +---------------------------------------+--------------------------------------------------------------+
    36. 

  36. 

  37. Method Descriptions
    38. 

  38. -------------------
    39. 

  39. 

  40. .. _class_Semaphore_method_post:
    41. 

  41. 

  42. - void **post** **(** **)**
    43. 

  43. 

  44. Lowers the ``Semaphore``, allowing one more thread in.
    45. 

  45. 

  46. ----
    47. 

  47. 

  48. .. _class_Semaphore_method_try_wait:
    49. 

  49. 

  50. - :ref:`Error<enum_@GlobalScope_Error>` **try_wait** **(** **)**
    51. 

  51. 

  52. Like :ref:`wait<class_Semaphore_method_wait>`, but won't block, so if the value is zero, fails immediately and returns :ref:`@GlobalScope.ERR_BUSY<class_@GlobalScope_constant_ERR_BUSY>`. If non-zero, it returns :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` to report success.
    53. 

  53. 

  54. ----
    55. 

  55. 

  56. .. _class_Semaphore_method_wait:
    57. 

  57. 

  58. - void **wait** **(** **)**
    59. 

  59. 

  60. Waits for the ``Semaphore``, if its value is zero, blocks until non-zero.
    61. 

  61.