Поддержка потоков

Команды поддержки потоков предназначены для указания уровня поддержки многопоточного программирования в классе или функции. Существует три уровня поддержки: threadsafe, reentrant и nonreentrant.

По умолчанию используется nonreentrant, что означает, что связанный класс или функция не могут вызываться из нескольких потоков. Reentrant и threadsafe — уровни, используемые преимущественно для классов.

Reentrant означает, что все функции в указанном классе могут вызываться одновременно из нескольких потоков при условии, что каждое вызов функции ссылается на уникальные данные. В то время как threadsafe означает, что все функции в указанном классе могут вызываться одновременно из нескольких потоков, даже когда каждое вызов ссылается на общие данные.

Когда класс помечен как \reentrant или \threadsafe, функции в этом классе могут быть помечены как nonreentrant с помощью команды \nonreentrant.

Пример

\beginqdoc
    \class QLocale
    \brief The QLocale class converts between numbers and their
    string representations in various languages.

    \reentrant
    \ingroup i18n
    \ingroup text

    QLocale is initialized with a language/country pair in its
    constructor and offers number-to-string and string-to-number
    conversion functions similar to those in QString.

    ...

    \nonreentrant

    Sets the global default locale to \a locale. These values are
    used when a QLocale object is constructed with no
    arguments. If this function is not called, the system's locale
    is used.

    \warning In a multithreaded application, the default locale
    should be set at application startup, before any non-GUI
    threads are created.

    \sa system(), c()
\endqdoc
void QLocale::setDefault(const QLocale &locale)
{
    default_d = locale.d;
}

QDoc отображает это как:

Класс QLocale

Класс QLocale преобразует числа и их строковые представления на различных языках. Подробнее...

#include <QLocale>

Примечание: Все функции в этом классе являются реентерабельными, за исключением setDefault().

...

---

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

...

void QLocale::setDefault ( const QLocale & locale )

Устанавливает глобальный локаль по умолчанию в locale. Эти значения используются при создании объекта QLocale без аргументов. Если эта функция не вызвана, используется локаль системы.

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

Предупреждение: Эта функция не является реентерабельной.

См. также system() и c().

...

Как показано выше, QDoc генерирует уведомление, когда класс объявлен реентерабельным, и перечисляет исключения (объявленные нереентерабельные функции). Включена ссылка на общую документацию по реентерабельности и потокобезопасности. Кроме того, в документации нереентерабельных функций генерируется предупреждение "Предупреждение: Эта функция не является реентерабельной".

QDoc сгенерирует такое же уведомление и предупреждения, когда класс объявлен потокобезопасным.

Дополнительную информацию см. в общей документации по реентерабельности и потокобезопасности.

Команды

\threadsafe

Команда \threadsafe включает строку в документацию, указывающую, что связанный класс или функция является потокобезопасным и может вызываться одновременно из нескольких потоков, даже если отдельные вызовы ссылаются на общие данные.

Команда должна стоять на отдельной строке.

Документация, сгенерированная с помощью этой команды, будет аналогична той, что генерируется для команды \reentrant. См. пример выше в разделе введение.

См. также \reentrant и \nonreentrant.

\reentrant

Команда \reentrant указывает, что связанный класс или функция могут вызываться одновременно из нескольких потоков при условии, что каждый вызов ссылается на свои собственные данные. См. пример выше.

Команда должна стоять на отдельной строке.

См. также \nonreentrant и \threadsafe.

\nonreentrant

Команда \nonreentrant указывает, что связанный класс или функция не могут вызываться из нескольких потоков. Нереентерабельный — это режим по умолчанию.

Команда должна стоять на отдельной строке.

Когда класс помечен как \reentrant или \threadsafe, функции в этом классе могут быть помечены nonreentrant с помощью этой команды в комментарии \fn функций, которые необходимо исключить.

См. также \reentrant и \threadsafe.