Класс QMutex

Класс QMutex обеспечивает сериализацию доступа между потоками. Подробнее...

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

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

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

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

Класс QMutex предназначен для защиты объекта, структуры данных или участка кода таким образом, чтобы к нему мог получить доступ только один поток одновременно (это аналогично ключевому слову Java synchronized). Обычно лучше использовать mutex с QMutexLocker, так как это упрощает обеспечение последовательного выполнения блокировки и разблокировки.

Например, предположим, что есть метод, который выводит сообщение пользователю на две строки:

int number = 6;

void method1()
{
    number *= 5;
    number /= 4;
}

void method2()
{
    number *= 3;
    number /= 2;
}

Если эти два метода вызываются последовательно, происходит следующее:

// method1()
number *= 5;        // number is now 30
number /= 4;        // number is now 7

// method2()
number *= 3;        // number is now 21
number /= 2;        // number is now 10

Если эти два метода вызываются одновременно из двух потоков, может получиться следующая последовательность:

// Thread 1 calls method1()
number *= 5;        // number is now 30

// Thread 2 calls method2().
//
// Most likely Thread 1 has been put to sleep by the operating
// system to allow Thread 2 to run.
number *= 3;        // number is now 90
number /= 2;        // number is now 45

// Thread 1 finishes executing.
number /= 4;        // number is now 11, instead of 10

Если мы добавим mutex, мы получим желаемый результат:

QMutex mutex;
int number = 6;

void method1()
{
    mutex.lock();
    number *= 5;
    number /= 4;
    mutex.unlock();
}

void method2()
{
    mutex.lock();
    number *= 3;
    number /= 2;
    mutex.unlock();
}

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

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

QMutex оптимизирован для быстродействия в неконкурентном случае. Он не выделяет память, если на mutex нет конкуренции. Он создаётся и уничтожается практически без накладных расходов, что означает, что иметь множество mutex в качестве части других классов не представляет проблемы.

См. также QRecursiveMutex, QMutexLocker, QReadWriteLock, QSemaphore и QWaitCondition.

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

QMutex::QMutex()

Создаёт новый mutex. Mutex создаётся в разблокированном состоянии.

QMutex::~QMutex()

Уничтожает mutex.

void QMutex::lock()

Заблокировать mutex. Если другой поток заблокировал mutex, этот вызов будет приостановлен, пока этот поток не разблокирует его.

Вызов этой функции несколько раз для одного и того же mutex из одного и того же потока приведёт к тупиковой ситуации.

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

bool QMutex::tryLock(int timeout)

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

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

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

Вызов этой функции несколько раз для одного и того же mutex из одного и того же потока приведёт к тупиковой ситуации.

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

bool QMutex::tryLock()

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

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

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

Вызов этой функции несколько раз для одного и того же mutex из одного и того же потока приведёт к тупиковой ситуации.

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

[since 5.8] bool QMutex::try_lock()

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

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

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

[since 5.8] template <typename Rep, typename Period> bool QMutex::try_lock_for(std::chrono::duration<Rep, Period> duration)

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

Примечание: Передача отрицательной продолжительности в качестве duration эквивалентна вызову try_lock(). Это поведение отличается от tryLock().

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

Вызов этой функции несколько раз для одного и того же mutex из одного и того же потока приведёт к тупиковой ситуации.

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

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

[since 5.8] template <typename Clock, typename Duration> bool QMutex::try_lock_until(std::chrono::time_point<Clock, Duration> timePoint)

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

Примечание: Передача timePoint, который уже прошёл, эквивалентна вызову try_lock(). Это поведение отличается от tryLock().

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

Вызов этой функции несколько раз для одного и того же mutex из одного и того же потока приведёт к тупиковой ситуации.

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

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

void QMutex::unlock()

Разблокирует mutex. Попытка разблокировать mutex в другом потоке, чем тот, который его заблокировал, приводит к ошибке. Разблокировка не заблокированного mutex приводит к неопределённому поведению.

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