Table of Contents

Class Semaphore

Namespace
Godot
Assembly
GodotSharp.dll

A synchronization semaphore that can be used to synchronize multiple GodotThreads. Initialized to zero on creation. For a binary version, see Mutex.

Warning: Semaphores must be used carefully to avoid deadlocks.

Warning: To guarantee that the operating system is able to perform proper cleanup (no crashes, no deadlocks), these conditions must be met:

- When a Semaphore's reference count reaches zero and it is therefore destroyed, no threads must be waiting on it.

- When a GodotThread's reference count reaches zero and it is therefore destroyed, it must not be waiting on any semaphore.

public class Semaphore : RefCounted, IDisposable
Inheritance
Semaphore
Implements
Inherited Members

Constructors

Semaphore() 

public Semaphore()

Methods

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool

Post()

Lowers the Semaphore, allowing one more thread in.

public void Post()

TryWait()

Like Wait(), but won't block, so if the value is zero, fails immediately and returns false. If non-zero, it returns true to report success.

public bool TryWait()

Returns

bool

Wait()

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

public void Wait()
Edit this page