Table Of Contents

Previous topic

QLibraryInfo

Next topic

QReadLocker

QWriteLocker

Inheritance diagram of QWriteLocker

Synopsis

Functions

Detailed Description

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

The purpose of PySide.QtCore.QWriteLocker (and PySide.QtCore.QReadLocker is to simplify PySide.QtCore.QReadWriteLock locking and unlocking. Locking and unlocking statements or in exception handling code is error-prone and difficult to debug. PySide.QtCore.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 PySide.QtCore.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 PySide.QtCore.QMutexLocker documentation shows examples where the use of a locker object greatly simplifies programming.

class PySide.QtCore.QWriteLocker(readWriteLock)
Parameters:readWriteLockPySide.QtCore.QReadWriteLock

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

PySide.QtCore.QWriteLocker.__enter__()
PySide.QtCore.QWriteLocker.__exit__(arg__1, arg__2, arg__3)
Parameters:
  • arg__1PyObject
  • arg__2PyObject
  • arg__3PyObject
PySide.QtCore.QWriteLocker.readWriteLock()
Return type:PySide.QtCore.QReadWriteLock

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

PySide.QtCore.QWriteLocker.relock()

Relocks an unlocked lock.

PySide.QtCore.QWriteLocker.unlock()

Unlocks the lock associated with this locker.