Класс QWaitCondition

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

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(QMutex *lockedMutex, QDeadlineTimer deadline)

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().

bool QWaitCondition::wait(QReadWriteLock *lockedReadWriteLock, QDeadlineTimer deadline)

void QWaitCondition::wakeAll()

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

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

void QWaitCondition::wakeOne()

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

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

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