Класс 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()

Создаёт новый объект условия ожидания.

QWaitCondition::~QWaitCondition()

Уничтожает объект условия ожидания.

void QWaitCondition::notify_all()

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

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

void QWaitCondition::notify_one()

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

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

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

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

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

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

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

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

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

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

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

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

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

void QWaitCondition::wakeAll()

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

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

void QWaitCondition::wakeOne()

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

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

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