Documentation
¶
Overview ¶
A synchronization mutex (mutual exclusion). This is used to synchronize multiple Threads, and is equivalent to a binary Semaphore. It guarantees that only one thread can access a critical section at a time.
This is a reentrant mutex, meaning that it can be locked multiple times by one thread, provided it also unlocks it as many times.
Warning: Mutexes must be used carefully to avoid deadlocks.
Warning: To ensure proper cleanup without crashes or deadlocks, the following conditions must be met:
- When a Mutex's reference count reaches zero and it is therefore destroyed, no threads (including the one on which the destruction will happen) must have it locked.
- When a Thread's reference count reaches zero and it is therefore destroyed, it must not have any mutex locked.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AsMutex() Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) ID() ID
- func (self Instance) Lock()
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) TryLock() bool
- func (self Instance) Unlock()
- func (self Instance) Virtual(name string) reflect.Value
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
func (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Instance ¶
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) Lock ¶
func (self Instance) Lock()
Locks this Mutex, blocks until it is unlocked by the current owner.
Note: This function returns without blocking if the thread already has ownership of the mutex.
func (Instance) TryLock ¶
Tries locking this Mutex, but does not block. Returns true on success, false otherwise.
Note: This function returns true if the thread already has ownership of the mutex.
func (Instance) Unlock ¶
func (self Instance) Unlock()
Unlocks this Mutex, leaving it to other threads.
Note: If a thread called Lock or TryLock multiple times while already having ownership of the mutex, it must also call Unlock the same number of times in order to unlock it correctly.
Warning: Calling Unlock more times that Lock on a given thread, thus ending up trying to unlock a non-locked mutex, is wrong and may causes crashes or deadlocks.
Source Files