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

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

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

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

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