QRecursiveMutex Class▲
-
Header: QRecursiveMutex
-
Since: Qt 5.14
-
CMake:
find_package(Qt6 REQUIRED COMPONENTS Core)
target_link_libraries(mytarget PRIVATE Qt6::Core)
-
qmake: QT += core
-
Group: QRecursiveMutex is part of thread
Detailed Description▲
The https:// class is a mutex, like https://, with which it is API-compatible. It differs from https:// by accepting https://() calls from the same thread any number of times. https:// would deadlock in this situation.
https:// is much more expensive to construct and operate on, so use a plain https:// whenever you can. Sometimes, one public function, however, calls another public function, and they both need to lock the same mutex. In this case, you have two options:
-
Factor the code that needs mutex protection into private functions, which assume that the mutex is held when they are called, and lock a plain https:// in the public functions before you call the private implementation ones.
-
Or use a recursive mutex, so it doesn't matter that the first public function has already locked the mutex when the second one wishes to do so.
See Also▲
See also https://, https://, https://, https://, https://
Member Function Documentation▲
[constexpr] QRecursiveMutex::QRecursiveMutex()▲
Constructs a new recursive mutex. The mutex is created in an unlocked state.
See Also▲
See also https://(), https://()
QRecursiveMutex::~QRecursiveMutex()▲
Destroys the mutex.
Destroying a locked mutex may result in undefined behavior.
void QRecursiveMutex::lock()▲
Locks the mutex. If another thread has locked the mutex then this call will block until that thread has unlocked it.
Calling this function multiple times on the same mutex from the same thread is allowed.
See Also▲
See also https://()
bool QRecursiveMutex::tryLock(int timeout = 0)▲
Attempts to lock the mutex. This function returns true if the lock was obtained; otherwise it returns false. If another thread has locked the mutex, this function will wait for at most timeout milliseconds for the mutex to become available.
Note: Passing a negative number as the timeout is equivalent to calling https://(), i.e. this function will wait forever until mutex can be locked if timeout is negative.
If the lock was obtained, the mutex must be unlocked with https://() before another thread can successfully lock it.
Calling this function multiple times on the same mutex from the same thread is allowed.
See Also▲
See also https://(), https://()
[since 5.8] bool QRecursiveMutex::try_lock()▲
Attempts to lock the mutex. This function returns true if the lock was obtained; otherwise it returns false.
This function is provided for compatibility with the Standard Library concept Lockable. It is equivalent to https://().
This function was introduced in Qt 5.8.
[since 5.8] bool QRecursiveMutex::try_lock_for(std::chrono::duration<Rep, Period> duration)▲
Attempts to lock the mutex. This function returns true if the lock was obtained; otherwise it returns false. If another thread has locked the mutex, this function will wait for at least duration for the mutex to become available.
Note: Passing a negative duration as the duration is equivalent to calling https://(). This behavior differs from https://().
If the lock was obtained, the mutex must be unlocked with https://() before another thread can successfully lock it.
Calling this function multiple times on the same mutex from the same thread is allowed.
This function was introduced in Qt 5.8.
See Also▲
See also https://(), https://()
[since 5.8] bool QRecursiveMutex::try_lock_until(std::chrono::time_point<Clock, Duration> timePoint)▲
Attempts to lock the mutex. This function returns true if the lock was obtained; otherwise it returns false. If another thread has locked the mutex, this function will wait at least until timePoint for the mutex to become available.
Note: Passing a timePoint which has already passed is equivalent to calling https://(). This behavior differs from https://().
If the lock was obtained, the mutex must be unlocked with https://() before another thread can successfully lock it.
Calling this function multiple times on the same mutex from the same thread is allowed.
This function was introduced in Qt 5.8.
See Also▲
See also https://(), https://()
void QRecursiveMutex::unlock()▲
Unlocks the mutex. Attempting to unlock a mutex in a different thread to the one that locked it results in an error. Unlocking a mutex that is not locked results in undefined behavior.
See Also▲
See also https://()


