Инструменты пользователя

Инструменты сайта


ru:airlay:api:air-lay-web-socket

Различия

Показаны различия между двумя версиями страницы.

Ссылка на это сравнение

Предыдущая версия справа и слева Предыдущая версия
Следующая версия
Предыдущая версия
ru:airlay:api:air-lay-web-socket [2024/04/01 11:05]
Рыков Павел [Коды ошибок:]
ru:airlay:api:air-lay-web-socket [2024/04/29 18:05] (текущий)
Рыков Павел [Типы событий]
Строка 1: Строка 1:
 ====== Описание ====== ====== Описание ======
- 
-==== Описание ====  
  
 Сервис websocket позволяет подписаться на события и получать уведомления о наступление соответствующего события Сервис websocket позволяет подписаться на события и получать уведомления о наступление соответствующего события
  
 Для получения уведомлений о наступление события фронтенд должен подключиться к сервису и отправить запрос на подписку на событий, после чего бэкенд будет отправлять сообщения с информацией о произошедшем событие Для получения уведомлений о наступление события фронтенд должен подключиться к сервису и отправить запрос на подписку на событий, после чего бэкенд будет отправлять сообщения с информацией о произошедшем событие
 +
 +====== Адрес веб сокета ======
 +<code>
 +wss://{domain}/ws
 +</code>
 +
 +====== Запуск ======
 +Для запуска сервера выполнить команду на сервере:
 +<code bach>
 +airlay-cli web_socket server
 +</code>
 +
 +====== Настройки ======
 +В файле ''config.ini'' заполнить секцию ''webSocketEvents'', указать ip-адрес и порт:
 +<code bach>
 +[webSocketEvents]
 +address = 0.0.0.0
 +port = 8081
 +</code>
 +
 ====== Запрос ====== ====== Запрос ======
  
Строка 32: Строка 50:
   - notification - оповещение об уведомление(ид не обязателен)   - notification - оповещение об уведомление(ид не обязателен)
   - datasetUpdate - обновление набора данных   - datasetUpdate - обновление набора данных
 +  - uploadFile - завершение загрузки в набор данных
 +  - downloadFile - завершение скачивания объектов или отчетов
  
 ==== Пример запроса ==== ==== Пример запроса ====
Строка 50: Строка 70:
 <code> <code>
 { {
-    "status":200+    "status": int
-    "message":"Ok"+    "message": string
-    "code":+    "code": int
 } }
 </code> </code>
Строка 71: Строка 91:
   *  4 - Not access for dataset   *  4 - Not access for dataset
   *  5 - Inavlid request   *  5 - Inavlid request
 +==== Пример ответа====
  
 +<code>
 +{
 +    "status":200,
 +    "message":"Ok",
 +    "code":
 +}
 +</code>
 +<code>
 +{
 +    "status":400,
 +    "message":"Invalid request",
 +    "code":
 +}
 +</code>
 ====== Сообщения от сервера ====== ====== Сообщения от сервера ======
  
ru/airlay/api/air-lay-web-socket.1711944338.txt.gz · Последнее изменение: 2024/04/01 11:05 — Рыков Павел