Документация
ОС Аврора 5.1.0

Класс TaskMessaging

Класс 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 не предназначен для запуска и остановки фоновых задач, а служит только для обмена сообщениями.

Обмен сообщениями осуществляется через локальный сокет, что обеспечивает эффективное взаимодействие в рамках одной системы. Класс поддерживает только асинхронное общение: сигнал messageReceived() испускается при поступлении нового сообщения, а метод sendMessage() позволяет отправить сообщение без блокировки вызывающего потока.

Описание перечислений

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, если соединение не установлено (например, когда сокет находится в состоянии Disconnected или Closing). В случае успешной отправки возвращает true.

state()

TaskMessaging::State TaskMessaging::state () const

Получает текущее состояние TaskMessaging. Метод позволяет в любой момент времени определить, установлено ли соединение, находится ли оно в процессе установки или завершения.

Возвращает текущее состояние TaskMessaging в виде значения перечисления State.

stateChanged

void RuntimeManager::TaskMessaging::stateChanged (State state) signal

Испускается при изменении состояния соединения. Сигнал позволяет приложению или фоновой задаче отслеживать переходы между состояниями Disconnected, Connecting, Connected и Closing и своевременно реагировать на них.

Параметры

state Текущее состояние соединения

См. также state()

Мы используем cookies для персонализации сайта и его более удобного использования. Вы можете запретить cookies в настройках браузера.

Пожалуйста ознакомьтесь с политикой использования файлов cookies.