Класс TaskMessaging
Управляет сообщениями между приложением и его фоновыми задачами. Подробнее…
#include <RuntimeManager/TaskMessaging>
Диаграмма наследования для RuntimeManager::TaskMessaging:
Публичные типы
| enum | State { Disconnected , Connecting , Connected , Closing } |
Сигналы
| void | stateChanged (State state) |
| void | messageReceived (const QJsonObject &message) |
Публичные функции
| TaskMessaging (const QString &socketPath, QObject *parent=Q_NULLPTR) | |
| TaskMessaging (qintptr serverSocket, QObject *parent=Q_NULLPTR) | |
| bool | sendMessage (const QJsonObject &message) |
| State | state () const |
Подробное описание
Управляет сообщениями между приложением и его фоновыми задачами.
Класс TaskMessaging не позволяет приложениям запускать и останавливать фоновые задачи, только
обмен сообщениями.
Описание перечислений
State
| enum RuntimeManager::TaskMessaging::State |
| Перечисления | |
|---|---|
| Disconnected | Сокет отключён |
| Connecting | Сокет подключается |
| Connected | Сокет подключён |
| Closing | Соединение завершает работу |
Описание конструкторов и деструктора
TaskMessaging() [1/2]
| TaskMessaging::TaskMessaging (const QString & socketPath, QObject * parent = Q_NULLPTR ) |
Конструктор.
Следует применять данный метод на стороне приложения для установки соединения с фоновой задачей.
Параметры
| socketPath | Путь к сокету, возвращаемый методом Task::socketPath() |
TaskMessaging() [2/2]
| TaskMessaging::TaskMessaging (qintptr serverSocket, QObject * parent = Q_NULLPTR ) |
Конструктор.
Следует использовать данный метод на стороне фоновой задачи для приёма соединения от приложения. Когда приложение подключится, будет испущен сигнал stateChanged().
Параметры
| serverSocket | Дескриптор файла сокета, возвращаемый методом RuntimeDispatcher::localServerSocket() |
Описание функций-членов
messageReceived
| void RuntimeManager::TaskMessaging::messageReceived (const QJsonObject & message) | signal |
Испускается при получении сообщения.
Параметры
| message | Сообщение в формате JSON |
sendMessage()
| bool TaskMessaging::sendMessage (const QJsonObject & message) |
Отправляет сообщение пиру.
Этот метод отправляет сообщение пиру неблокирующим способом.
Параметры
| message | Сообщение в формате JSON |
Возвращает false, если отключён.
state()
| TaskMessaging::State TaskMessaging::state () const |
Получает текущее состояние TaskMessaging.
Возвращает текущее состояние TaskMessaging.
stateChanged
| void RuntimeManager::TaskMessaging::stateChanged (State state) | signal |
Испускается при изменении состояния соединения.
Параметры
| state | Текущее состояние соединения |
См. также state()