Класс QWaitCondition

Класс QWaitCondition предоставляет переменную условия для синхронизации потоков. Подробнее...

• Список всех членов, включая наследуемые

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

Открытые функции

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

QWaitCondition позволяет одному потоку сообщать другим потокам, что какое-то условие выполнено. Один или несколько потоков могут блокироваться, ожидая, пока QWaitCondition не установит условие с помощью wakeOne() или wakeAll(). Используйте wakeOne(), чтобы разбудить один случайный поток, или wakeAll(), чтобы разбудить все.

Например, предположим, что у нас есть три задачи, которые должны выполняться всякий раз, когда пользователь нажимает клавишу. Каждая задача может быть разделена на поток, каждый из которых будет иметь тело run() вот так:

forever {
    mutex.lock();
    keyPressed.wait(&mutex);
    do_something();
    mutex.unlock();
}

Здесь переменная keyPressed — это глобальная переменная типа QWaitCondition.

Четвертый поток будет считывать нажатия клавиш и разбуживать три других потока каждый раз, когда он получит нажатие, примерно так:

forever {
    getchar();
    keyPressed.wakeAll();
}

Порядок, в котором будятся три потока, не определён. Кроме того, если некоторые потоки всё ещё находятся в do_something(), когда нажимается клавиша, они не будут разбужены (поскольку они не ожидают переменной условия), и поэтому задача не будет выполнена для этого нажатия клавиши. Эту проблему можно решить, используя счётчик и QMutex для его защиты. Например, вот новый код для потоков-обработчиков:

forever {
    mutex.lock();
    keyPressed.wait(&mutex);
    ++count;
    mutex.unlock();

    do_something();

    mutex.lock();
    --count;
    mutex.unlock();
}

Вот код для четвёртого потока:

forever {
    getchar();

    mutex.lock();
    // Sleep until there are no busy worker threads
    while (count > 0) {
        mutex.unlock();
        sleep(1);
        mutex.lock();
    }
    keyPressed.wakeAll();
    mutex.unlock();
}

Мьютекс необходим, потому что результаты попыток двух потоков изменить значение одной и той же переменной одновременно непредсказуемы.

Переменные условий — мощный инструмент синхронизации потоков. Пример Wait Conditions Example демонстрирует, как использовать QWaitCondition в качестве альтернативы QSemaphore для управления доступом к кольцевому буферу, которым обмениваются производитель и потребитель потоков.

См. также QMutex, QSemaphore, QThread и Wait Conditions Example.

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

QWaitCondition::QWaitCondition()

Создаёт новый объект wait condition.

QWaitCondition::~QWaitCondition()

Уничтожает объект wait condition.

[since 5.8] void QWaitCondition::notify_all()

Эта функция предоставляется для совместимости со STL. Она эквивалентна wakeAll().

Эта функция была добавлена в Qt 5.8.

[since 5.8] void QWaitCondition::notify_one()

Эта функция предоставляется для совместимости со STL. Она эквивалентна wakeOne().

Эта функция была добавлена в Qt 5.8.

[since 5.12] bool QWaitCondition::wait(QMutex *lockedMutex, QDeadlineTimer deadline = QDeadlineTimer(QDeadlineTimer::Forever))

Освобождает lockedMutex и ожидает переменной условия. lockedMutex должен быть заблокирован вызывающим потоком. Если lockedMutex не в заблокированном состоянии, поведение неопределённо. Если lockedMutex — рекурсивный мьютекс, эта функция возвращается немедленно. lockedMutex будет разблокирован, и вызывающий поток будет блокироваться, пока не будет выполнено одно из следующих условий:

• Другой поток подаёт сигнал с помощью wakeOne() или wakeAll(). В этом случае функция вернёт true.
• достигнут срок, заданный deadline. Если deadline равен QDeadlineTimer::Forever, (по умолчанию), ожидание никогда не истечёт (событие должно быть сигнализировано). Функция вернёт false, если ожидание истекло.

lockedMutex будет возвращён в то же заблокированное состояние. Эта функция предназначена для атомарного перехода от заблокированного состояния к состоянию ожидания.

Эта функция была добавлена в Qt 5.12.

См. также wakeOne() и wakeAll().

bool QWaitCondition::wait(QMutex *lockedMutex, unsigned long time)

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

[since 5.12] bool QWaitCondition::wait(QReadWriteLock *lockedReadWriteLock, QDeadlineTimer deadline = QDeadlineTimer(QDeadlineTimer::Forever))

Освобождает lockedReadWriteLock и ожидает переменной условия. lockedReadWriteLock должен быть заблокирован вызывающим потоком. Если lockedReadWriteLock не в заблокированном состоянии, функция возвращается немедленно. lockedReadWriteLock не должен быть заблокирован рекурсивно, в противном случае функция не разблокирует его должным образом. lockedReadWriteLock будет разблокирован, и вызывающий поток будет блокироваться, пока не будет выполнено одно из следующих условий:

• Другой поток подаёт сигнал с помощью wakeOne() или wakeAll(). В этом случае функция вернёт true.
• достигнут срок, заданный deadline. Если deadline равен QDeadlineTimer::Forever, (по умолчанию), ожидание никогда не истечёт (событие должно быть сигнализировано). Функция вернёт false, если ожидание истекло.

lockedReadWriteLock будет возвращён в то же заблокированное состояние. Эта функция предназначена для атомарного перехода от заблокированного состояния к состоянию ожидания.

Эта функция была добавлена в Qt 5.12.

См. также wakeOne() и wakeAll().

bool QWaitCondition::wait(QReadWriteLock *lockedReadWriteLock, unsigned long time)

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

void QWaitCondition::wakeAll()

Разбуждает все потоки, ожидающие переменной условия. Порядок разбуждения потоков зависит от политики планирования операционной системы и не может быть контролируем или предсказан.

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

void QWaitCondition::wakeOne()

Разбуждает один поток, ожидающий переменной условия. Поток, который будится, зависит от политики планирования операционной системы и не может быть контролируем или предсказан.

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

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