Тип WorkerScript QML

Позволяет использовать потоки в приложении Qt Quick. Подробнее...

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

Свойства

• ready : bool
• source : url

Сигналы

• message(jsobject msg)

Методы

• sendMessage(jsobject message)

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

Используйте WorkerScript для выполнения операций в новом потоке. Это полезно для выполнения операций в фоновом режиме, чтобы основной поток GUI не блокировался.

Сообщения могут передаваться между новым потоком и родительским потоком с помощью sendMessage() и обработчика onMessage().

Пример:

import QtQuick 2.0

Rectangle {
    width: 300; height: 300

    Text {
        id: myText
        text: 'Click anywhere'
    }

    WorkerScript {
        id: myWorker
        source: "script.mjs"

        onMessage: myText.text = messageObject.reply
    }

    MouseArea {
        anchors.fill: parent
        onClicked: myWorker.sendMessage({ 'x': mouse.x, 'y': mouse.y })
    }
}

Вышеприведенный скрипт worker указывает на JavaScript-файл "script.mjs", который обрабатывает операции, которые должны выполняться в новом потоке. Вот script.mjs:

WorkerScript.onMessage = function(message) {
    // ... long-running operations and calculations are done here
    WorkerScript.sendMessage({ 'reply': 'Mouse is at ' + message.x + ',' + message.y })
}

Когда пользователь нажимает на любой области прямоугольника, sendMessage() вызывается, активируя обработчик WorkerScript.onMessage() в script.mjs. Это, в свою очередь, отправляет сообщение с ответом, которое затем получает обработчик onMessage() объекта myWorker.

В примере используется скрипт, который является модулем ECMAScript, потому что имеет расширение ".mjs". Он может использовать инструкции import для доступа к функциональности из других модулей и выполняется в режиме строгой проверки JavaScript.

Если скрипт worker имеет расширение ".js", то он считается содержащим обычные операторы JavaScript и выполняется в режиме нестрогой проверки.

Примечание: Каждый элемент WorkerScript создаст отдельный движок JavaScript для обеспечения идеальной изоляции и безопасности потоков. Если это приводит к слишком большому потреблению памяти для вашей среды, то рассмотрите возможность совместного использования элемента WorkerScript.

Ограничения

Поскольку функция WorkerScript.onMessage() выполняется в отдельном потоке, JavaScript-файл оценивается в контексте, отдельном от основного движка QML. Это означает, что, в отличие от обычного JavaScript-файла, который импортируется в QML, script.mjs в приведенном выше примере не может получить доступ к свойствам, методам или другим атрибутам элемента QML, а также не может получить доступ к свойствам контекста, установленным на объекте QML через QQmlContext.

Кроме того, существуют ограничения на типы значений, которые могут передаваться в скрипт worker и из него. Подробности см. в документации к sendMessage().

Скрипты worker, которые представляют собой обычные JavaScript-источники, не могут использовать синтаксис .import. Скрипты, которые являются модулями ECMAScript, могут свободно использовать инструкции import и export.

См. также Примеры Qt Quick — Потоки и Пример Threaded ListModel.

Документация по свойствам

ready : bool

Указывает, был ли инициализирован WorkerScript и готов ли он получать сообщения через WorkerScript.sendMessage().

source : url

Содержит URL-адрес JavaScript-файла, который реализует обработчик WorkerScript.onMessage() для операций в потоке.

Если компонент имени файла в URL заканчивается ".mjs", то скрипт анализируется как модуль ECMAScript и выполняется в режиме строгой проверки. В противном случае он считается обычным скриптом.

Документация по сигналам

message(jsobject msg)

Этот сигнал излучается, когда сообщение msg получено от скрипта worker в другом потоке через вызов sendMessage().

Примечание: Соответствующий обработчик — onMessage.

Документация по методам

sendMessage(jsobject message)

Отправляет указанное message обработчику скрипта worker в другом потоке. Другой обработчик скрипта worker может получить это сообщение через обработчик onMessage().

Объект message может содержать только значения следующих типов:

• boolean, число, строка
• объекты и массивы JavaScript
• объекты ListModel (любой другой тип QObject* запрещен)

Все объекты и массивы копируются в message. За исключением объектов ListModel, любые изменения в объекте, произведенные другим потоком, переданном в message, не будут отражены в исходном объекте.