QWriteLocker

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

Inheritance diagram of PySide2.QtCore.QWriteLocker

Synopsis

Functions

Detailed Description

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

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

lock = QReadWriteLock()

def writeData(data):
    locker = QWriteLocker(lock)
    # ...

It is equivalent to the following code:

lock = QReadWriteLock()

def writeData(data):
    locker.lockForWrite()
    # ...
    locker.unlock()

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

class PySide2.QtCore.QWriteLocker(readWriteLock)
param readWriteLock

PySide2.QtCore.QReadWriteLock

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

See also

lockForWrite()

PySide2.QtCore.QWriteLocker.__enter__()
PySide2.QtCore.QWriteLocker.__exit__(arg__1, arg__2, arg__3)
Parameters
  • arg__1 – object

  • arg__2 – object

  • arg__3 – object

PySide2.QtCore.QWriteLocker.readWriteLock()
Return type

PySide2.QtCore.QReadWriteLock

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

PySide2.QtCore.QWriteLocker.relock()

Relocks an unlocked lock.

See also

unlock()

PySide2.QtCore.QWriteLocker.unlock()

Unlocks the lock associated with this locker.

See also

unlock()