[−][src]Struct qt_core::QMutex
The QMutex class provides access serialization between threads.
C++ class: QMutex
.
The QMutex class provides access serialization between threads.
The purpose of a QMutex is to protect an object, data structure or section of code so that only one thread can access it at a time (this is similar to the Java synchronized
keyword). It is usually best to use a mutex with a QMutexLocker since this makes it easy to ensure that locking and unlocking are performed consistently.
For example, say there is a method that prints a message to the user on two lines:
int number = 6;
void method1() { number *= 5; number /= 4; }
void method2() { number *= 3; number /= 2; }
If these two methods are called in succession, the following happens:
// method1() number *= 5; // number is now 30 number /= 4; // number is now 7
// method2() number *= 3; // number is now 21 number /= 2; // number is now 10
If these two methods are called simultaneously from two threads then the following sequence could result:
// Thread 1 calls method1() number *= 5; // number is now 30
// Thread 2 calls method2(). // // Most likely Thread 1 has been put to sleep by the operating // system to allow Thread 2 to run. number *= 3; // number is now 90 number /= 2; // number is now 45
// Thread 1 finishes executing. number /= 4; // number is now 11, instead of 10
If we add a mutex, we should get the result we want:
QMutex mutex; int number = 6;
void method1() { mutex.lock(); number *= 5; number /= 4; mutex.unlock(); }
void method2() { mutex.lock(); number *= 3; number /= 2; mutex.unlock(); }
Then only one thread can modify number
at any given time and the result is correct. This is a trivial example, of course, but applies to any other case where things need to happen in a particular sequence.
When you call lock() in a thread, other threads that try to call lock() in the same place will block until the thread that got the lock calls unlock(). A non-blocking alternative to lock() is tryLock().
QMutex is optimized to be fast in the non-contended case. A non-recursive QMutex will not allocate memory if there is no contention on that mutex. It is constructed and destroyed with almost no overhead, which means it is fine to have many mutexes as part of other classes.
Methods
impl QMutex
[src]
pub unsafe fn is_recursive(&self) -> bool
[src]
Returns true
if the mutex is recursive.
Calls C++ function: bool QMutex::isRecursive() const
.
Returns true
if the mutex is recursive.
This function was introduced in Qt 5.7.
pub unsafe fn lock(&self)
[src]
Locks the mutex. If another thread has locked the mutex then this call will block until that thread has unlocked it.
Calls C++ function: void QMutex::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 if this mutex is a recursive mutex. If this mutex is a non-recursive mutex, this function will dead-lock when the mutex is locked recursively.
See also unlock().
pub unsafe fn new_1a(mode: RecursionMode) -> CppBox<QMutex>
[src]
Constructs a new mutex. The mutex is created in an unlocked state.
Calls C++ function: [constructor] void QMutex::QMutex(QMutex::RecursionMode mode = …)
.
Constructs a new mutex. The mutex is created in an unlocked state.
If mode is QMutex::Recursive, a thread can lock the same mutex multiple times and the mutex won't be unlocked until a corresponding number of unlock() calls have been made. Otherwise a thread may only lock a mutex once. The default is QMutex::NonRecursive.
Recursive mutexes are slower and take more memory than non-recursive ones.
pub unsafe fn new_0a() -> CppBox<QMutex>
[src]
The QMutex class provides access serialization between threads.
Calls C++ function: [constructor] void QMutex::QMutex()
.
The QMutex class provides access serialization between threads.
The purpose of a QMutex is to protect an object, data structure or section of code so that only one thread can access it at a time (this is similar to the Java synchronized
keyword). It is usually best to use a mutex with a QMutexLocker since this makes it easy to ensure that locking and unlocking are performed consistently.
For example, say there is a method that prints a message to the user on two lines:
int number = 6;
void method1() { number *= 5; number /= 4; }
void method2() { number *= 3; number /= 2; }
If these two methods are called in succession, the following happens:
// method1() number *= 5; // number is now 30 number /= 4; // number is now 7
// method2() number *= 3; // number is now 21 number /= 2; // number is now 10
If these two methods are called simultaneously from two threads then the following sequence could result:
// Thread 1 calls method1() number *= 5; // number is now 30
// Thread 2 calls method2(). // // Most likely Thread 1 has been put to sleep by the operating // system to allow Thread 2 to run. number *= 3; // number is now 90 number /= 2; // number is now 45
// Thread 1 finishes executing. number /= 4; // number is now 11, instead of 10
If we add a mutex, we should get the result we want:
QMutex mutex; int number = 6;
void method1() { mutex.lock(); number *= 5; number /= 4; mutex.unlock(); }
void method2() { mutex.lock(); number *= 3; number /= 2; mutex.unlock(); }
Then only one thread can modify number
at any given time and the result is correct. This is a trivial example, of course, but applies to any other case where things need to happen in a particular sequence.
When you call lock() in a thread, other threads that try to call lock() in the same place will block until the thread that got the lock calls unlock(). A non-blocking alternative to lock() is tryLock().
QMutex is optimized to be fast in the non-contended case. A non-recursive QMutex will not allocate memory if there is no contention on that mutex. It is constructed and destroyed with almost no overhead, which means it is fine to have many mutexes as part of other classes.
pub unsafe fn try_lock_int(&self, timeout: c_int) -> bool
[src]
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.
Calls C++ function: bool QMutex::tryLock(int timeout = …)
.
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 lock(), 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 unlock() before another thread can successfully lock it.
Calling this function multiple times on the same mutex from the same thread is allowed if this mutex is a recursive mutex. If this mutex is a non-recursive mutex, this function will always return false when attempting to lock the mutex recursively.
pub unsafe fn try_lock(&self) -> bool
[src]
Attempts to lock the mutex. This function returns true
if the lock was obtained; otherwise it returns false
.
Calls C++ function: bool QMutex::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 tryLock().
The function returns true
if the lock was obtained; otherwise it returns false
This function was introduced in Qt 5.8.
pub unsafe fn try_lock2(&self) -> bool
[src]
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.
Calls C++ function: bool QMutex::tryLock()
.
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 lock(), 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 unlock() before another thread can successfully lock it.
Calling this function multiple times on the same mutex from the same thread is allowed if this mutex is a recursive mutex. If this mutex is a non-recursive mutex, this function will always return false when attempting to lock the mutex recursively.
pub unsafe fn unlock(&self)
[src]
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.
Calls C++ function: void QMutex::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 lock().
Methods from Deref<Target = QBasicMutex>
pub unsafe fn is_recursive_mut(&self) -> bool
[src]
Calls C++ function: bool QBasicMutex::isRecursive()
.
pub unsafe fn is_recursive(&self) -> bool
[src]
Calls C++ function: bool QBasicMutex::isRecursive() const
.
pub unsafe fn lock(&self)
[src]
Calls C++ function: void QBasicMutex::lock()
.
pub unsafe fn try_lock(&self) -> bool
[src]
Calls C++ function: bool QBasicMutex::tryLock()
.
pub unsafe fn try_lock2(&self) -> bool
[src]
Calls C++ function: bool QBasicMutex::try_lock()
.
pub unsafe fn unlock(&self)
[src]
Calls C++ function: void QBasicMutex::unlock()
.
Trait Implementations
impl CppDeletable for QMutex
[src]
unsafe fn delete(&self)
[src]
Destroys the mutex.
Calls C++ function: [destructor] void QMutex::~QMutex()
.
Destroys the mutex.
Warning: Destroying a locked mutex may result in undefined behavior.
impl Deref for QMutex
[src]
type Target = QBasicMutex
The resulting type after dereferencing.
fn deref(&self) -> &QBasicMutex
[src]
Calls C++ function: QBasicMutex* static_cast<QBasicMutex*>(QMutex* ptr)
.
impl StaticDowncast<QMutex> for QBasicMutex
[src]
unsafe fn static_downcast(ptr: Ptr<QBasicMutex>) -> Ptr<QMutex>
[src]
Calls C++ function: QMutex* static_cast<QMutex*>(QBasicMutex* ptr)
.
impl StaticUpcast<QBasicMutex> for QMutex
[src]
unsafe fn static_upcast(ptr: Ptr<QMutex>) -> Ptr<QBasicMutex>
[src]
Calls C++ function: QBasicMutex* static_cast<QBasicMutex*>(QMutex* ptr)
.
Auto Trait Implementations
impl RefUnwindSafe for QMutex
impl Send for QMutex
impl Sync for QMutex
impl Unpin for QMutex
impl UnwindSafe for QMutex
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T, U> CastInto<U> for T where
U: CastFrom<T>,
[src]
U: CastFrom<T>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> StaticUpcast<T> for T
[src]
unsafe fn static_upcast(ptr: Ptr<T>) -> Ptr<T>
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,