Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

Mutex

繼承： RefCounted < Object

二元 Semaphore，用於在多 Thread 間進行同步。

說明

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: 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.

教學

方法

void	lock()
bool	try_lock()
void	unlock()

方法說明

void lock() 🔗

鎖定此 Mutex，直到被目前所有者解鎖為止。

注意：如果執行緒已經擁有互斥鎖的所有權，該函式將無阻塞地返回。

bool try_lock() 🔗

嘗試鎖定該 Mutex，但不會阻塞。成功時返回 true，否則返回 false。

注意：如果該執行緒已經擁有了該互斥器的所有權，則函式返回 true。

void unlock() 🔗

Unlocks this Mutex, leaving it to other threads.

Note: If a thread called lock() or try_lock() 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 than lock() on a given thread, thus ending up trying to unlock a non-locked mutex, is wrong and may causes crashes or deadlocks.