Mutex

Documentation

Overview

Package Mutex provides methods for working with Mutex object instances.

Index

• type Advanced
• type Any
• type Instance
  • func New() Instance
  • func (self Instance) AsMutex() Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsRefCounted() [1]gd.RefCounted
  • func (self Instance) Lock()
  • func (self Instance) TryLock() bool
  • func (self Instance) Unlock()
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value

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 Any

type Any interface {
	gd.IsClass
	AsMutex() Instance
}

type Instance

type Instance [1]gdclass.Mutex

A synchronization mutex (mutual exclusion). This is used to synchronize multiple [Thread]s, 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. [b]Warning:[/b] Mutexes must be used carefully to avoid deadlocks. [b]Warning:[/b] 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.

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AsMutex

func (self Instance) AsMutex() Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

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. [b]Note:[/b] This function returns without blocking if the thread already has ownership of the mutex.

func (Instance) TryLock

func (self Instance) TryLock() bool

Tries locking this [Mutex], but does not block. Returns [code]true[/code] on success, [code]false[/code] otherwise. [b]Note:[/b] This function returns [code]true[/code] if the thread already has ownership of the mutex.

func (Instance) Unlock

func (self Instance) Unlock()

Unlocks this [Mutex], leaving it to other threads. [b]Note:[/b] If a thread called [method lock] or [method try_lock] multiple times while already having ownership of the mutex, it must also call [method unlock] the same number of times in order to unlock it correctly. [b]Warning:[/b] Calling [method unlock] more times that [method lock] on a given thread, thus ending up trying to unlock a non-locked mutex, is wrong and may causes crashes or deadlocks.

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value