QReadLocker

The QReadLocker class is a convenience class that simplifies locking and unlocking read-write locks for read access. More

Inheritance diagram of PySide6.QtCore.QReadLocker

Synopsis

Functions

Detailed Description

The purpose of QReadLocker (and QWriteLocker ) is to simplify QReadWriteLock locking and unlocking. Locking and unlocking statements or in exception handling code is error-prone and difficult to debug. QReadLocker can be used in such situations to ensure that the state of the lock is always well-defined.

Here’s an example that uses QReadLocker to lock and unlock a read-write lock for reading:

QReadWriteLock lock;

QByteArray readData()
{
    QReadLocker locker(&lock);
    ...
    return data;
}

It is equivalent to the following code:

QReadWriteLock lock;

QByteArray readData()
{
    lock.lockForRead();
    ...
    lock.unlock();
    return data;
}

The QMutexLocker documentation shows examples where the use of a locker object greatly simplifies programming.

class PySide6.QtCore.QReadLocker(readWriteLock)
Parameters

readWriteLockPySide6.QtCore.QReadWriteLock

Constructs a QReadLocker and locks lock for reading. The lock will be unlocked when the QReadLocker is destroyed. If lock is zero, QReadLocker does nothing.

See also

lockForRead()

PySide6.QtCore.QReadLocker.__enter__()
PySide6.QtCore.QReadLocker.__exit__(arg__1, arg__2, arg__3)
Parameters
  • arg__1 – object

  • arg__2 – object

  • arg__3 – object

PySide6.QtCore.QReadLocker.readWriteLock()
Return type

PySide6.QtCore.QReadWriteLock

Returns a pointer to the read-write lock that was passed to the constructor.

PySide6.QtCore.QReadLocker.relock()

Relocks an unlocked lock.

See also

unlock()

PySide6.QtCore.QReadLocker.unlock()

Unlocks the lock associated with this locker.

See also

unlock()