Spec-Zone.ru › Qt 6.1

Класс QReadWriteLock

Класс QReadWriteLock предоставляет механизм блокировки для чтения и записи. Подробнее...

Заголовок: #include <QReadWriteLock>
CMake: find_package(Qt6 COMPONENTS Core REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Core)
qmake: QT += core
  • Список всех членов, включая унаследованные

Примечание: Все функции в этом классе являются потокобезопасными.

Типы публичного доступа

Перечисление RecursionMode { Recursive, NonRecursive }

Функции публичного доступа

QReadWriteLock(QReadWriteLock::RecursionMode recursionMode = NonRecursive)
~QReadWriteLock()
void lockForRead()
void lockForWrite()
bool tryLockForRead()
bool tryLockForRead(int timeout)
bool tryLockForWrite()
bool tryLockForWrite(int timeout)
void unlock()

Подробное описание

Блокировка для чтения-записи — это инструмент синхронизации для защиты ресурсов, к которым можно получить доступ для чтения и записи. Этот тип блокировки полезен, если вы хотите разрешить нескольким потокам одновременный доступ только для чтения, но как только один поток захочет записать в ресурс, все остальные потоки должны быть заблокированы до завершения записи.

Во многих случаях QReadWriteLock — прямой конкурент QMutex. QReadWriteLock — хороший выбор, если есть много одновременных операций чтения, а записи выполняются нечасто.

Пример:

QReadWriteLock lock;

void ReaderThread::run()
{
    ...
    lock.lockForRead();
    read_file();
    lock.unlock();
    ...
}

void WriterThread::run()
{
    ...
    lock.lockForWrite();
    write_file();
    lock.unlock();
    ...
}

Чтобы гарантировать, что пишущие потоки не будут заблокированы читающими потоками навсегда, читающие потоки, пытающиеся получить блокировку, не будут успешны, если есть заблокированный пишущий поток, ожидающий доступа, даже если блокировка в настоящее время используется только другими читающими потоками. Также, если блокировка используется пишущим потоком, и вступает другой пишущий поток, этот пишущий поток получит приоритет над любыми читающими потоками, которые также могут ожидать.

Как и QMutex, QReadWriteLock может быть рекурсивно заблокирован одним и тем же потоком, если он был создан с QReadWriteLock::Recursive как QReadWriteLock::RecursionMode. В таких случаях, unlock() должен вызываться столько же раз, сколько вызывались lockForWrite() или lockForRead(). Обратите внимание, что тип блокировки не может быть изменён при рекурсивном блокировании, т.е. невозможно заблокировать для чтения в потоке, который уже заблокировал для записи (и наоборот).

См. также QReadLocker, QWriteLocker, QMutex и QSemaphore.

Документация по типам членов

Перечисление QReadWriteLock::RecursionMode

Константа Значение Описание
QReadWriteLock::Recursive 1 В этом режиме поток может многократно блокировать ту же QReadWriteLock. QReadWriteLock не будет разблокирована, пока не будет выполнено соответствующее количество вызовов unlock().
QReadWriteLock::NonRecursive 0 В этом режиме поток может заблокировать QReadWriteLock только один раз.

См. также QReadWriteLock().

Документация по функциям-членам

QReadWriteLock::QReadWriteLock(QReadWriteLock::RecursionMode recursionMode = NonRecursive)

Создаёт объект QReadWriteLock в указанном режиме recursionMode.

По умолчанию режим рекурсии — NonRecursive.

См. также lockForRead(), lockForWrite() и RecursionMode.

QReadWriteLock::~QReadWriteLock()

Удаляет объект QReadWriteLock.

Предупреждение: Удаление блокировки чтения-записи, которая используется, может привести к неопределённому поведению.

void QReadWriteLock::lockForRead()

Блокирует блокировку для чтения. Эта функция заблокирует текущий поток, если другой поток заблокировал её для записи.

Невозможно заблокировать для чтения, если поток уже заблокирован для записи.

См. также unlock(), lockForWrite() и tryLockForRead().

void QReadWriteLock::lockForWrite()

Блокирует блокировку для записи. Эта функция заблокирует текущий поток, если другой поток (включая текущий) заблокировал её для чтения или записи (если блокировка не была создана с помощью режима QReadWriteLock::Recursive).

Невозможно заблокировать для записи, если поток уже заблокирован для чтения.

См. также unlock(), lockForRead() и tryLockForWrite().

bool QReadWriteLock::tryLockForRead()

Пытается заблокировать для чтения. Если блокировка была получена, эта функция возвращает true, в противном случае возвращает false, вместо ожидания, пока блокировка станет доступной, т.е. не блокируется.

Попытка блокировки завершится неудачей, если другой поток заблокировал её для записи.

Если блокировка была получена, её необходимо разблокировать с помощью unlock() перед тем, как другой поток сможет успешно заблокировать её для записи.

Невозможно заблокировать для чтения, если поток уже заблокирован для записи.

См. также unlock() и lockForRead().

bool QReadWriteLock::tryLockForRead(int timeout)

Это перегруженная функция.

Пытается заблокировать для чтения. Эта функция возвращает true если блокировка была получена; в противном случае возвращает false. Если другой поток заблокировал её для записи, эта функция будет ждать не более timeout миллисекунд, пока блокировка станет доступной.

Примечание: Передача отрицательного числа в качестве timeout эквивалентна вызову lockForRead(), т.е. эта функция будет ждать вечно, пока блокировка не сможет быть заблокирована для чтения, когда timeout отрицательный.

Если блокировка была получена, её необходимо разблокировать с помощью unlock() перед тем, как другой поток сможет успешно заблокировать её для записи.

Невозможно заблокировать для чтения, если поток уже заблокирован для записи.

См. также unlock() и lockForRead().

bool QReadWriteLock::tryLockForWrite()

Пытается заблокировать для записи. Если блокировка была получена, эта функция возвращает true; в противном случае, она возвращает false немедленно.

Попытка блокировки завершится неудачей, если другой поток заблокировал её для чтения или записи.

Если блокировка была получена, её необходимо разблокировать с помощью unlock() перед тем, как другой поток сможет успешно заблокировать её.

Невозможно заблокировать для записи, если поток уже заблокирован для чтения.

См. также unlock() и lockForWrite().

bool QReadWriteLock::tryLockForWrite(int timeout)

Это перегруженная функция.

Пытается заблокировать для записи. Эта функция возвращает true если блокировка была получена; в противном случае возвращает false. Если другой поток заблокировал её для чтения или записи, эта функция будет ждать не более timeout миллисекунд, пока блокировка станет доступной.

Примечание: Передача отрицательного числа в качестве timeout эквивалентна вызову lockForWrite(), т.е. эта функция будет ждать вечно, пока блокировка не сможет быть заблокирована для записи, когда timeout отрицательный.

Если блокировка была получена, её необходимо разблокировать с помощью unlock() перед тем, как другой поток сможет успешно заблокировать её.

Невозможно заблокировать для записи, если поток уже заблокирован для чтения.

См. также unlock() и lockForWrite().

void QReadWriteLock::unlock()

Разблокирует замок.

Попытка разблокировать замок, который не заблокирован, является ошибкой и приведет к завершению программы.

См. также lockForRead(), lockForWrite(), tryLockForRead(), и tryLockForWrite().

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.1/qreadwritelock.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API