Инструменты пользователя
ru:airlay:api:air-lay-web-socket
Различия
Показаны различия между двумя версиями страницы.
| Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
|
ru:airlay:api:air-lay-web-socket [2024/04/01 11:01] Рыков Павел [Описание] |
ru:airlay:api:air-lay-web-socket [2024/04/29 18:05] (текущий) Рыков Павел [Типы событий] |
||
|---|---|---|---|
| Строка 1: | Строка 1: | ||
| ====== Описание ====== | ====== Описание ====== | ||
| - | ==== Описание ==== | + | Сервис websocket позволяет подписаться на события и получать уведомления о наступление соответствующего события |
| + | |||
| + | Для получения уведомлений о наступление события фронтенд должен подключиться к сервису и отправить запрос на подписку на событий, | ||
| + | |||
| + | ====== Адрес веб сокета ====== | ||
| + | < | ||
| + | wss:// | ||
| + | </ | ||
| + | |||
| + | ====== Запуск ====== | ||
| + | Для запуска сервера выполнить команду на сервере: | ||
| + | <code bach> | ||
| + | airlay-cli web_socket server | ||
| + | </ | ||
| + | |||
| + | ====== Настройки ====== | ||
| + | В файле '' | ||
| + | <code bach> | ||
| + | [webSocketEvents] | ||
| + | address = 0.0.0.0 | ||
| + | port = 8081 | ||
| + | </ | ||
| - | Для получения событий фронтенд должен подключиться к сервису и отправить запрос на подписку событий | ||
| ====== Запрос ====== | ====== Запрос ====== | ||
| Строка 30: | Строка 50: | ||
| - notification - оповещение об уведомление(ид не обязателен) | - notification - оповещение об уведомление(ид не обязателен) | ||
| - datasetUpdate - обновление набора данных | - datasetUpdate - обновление набора данных | ||
| + | - uploadFile - завершение загрузки в набор данных | ||
| + | - downloadFile - завершение скачивания объектов или отчетов | ||
| ==== Пример запроса ==== | ==== Пример запроса ==== | ||
| Строка 48: | Строка 70: | ||
| < | < | ||
| { | { | ||
| - | " | + | " |
| - | " | + | " |
| - | " | + | " |
| } | } | ||
| </ | </ | ||
| Строка 57: | Строка 79: | ||
| * code - код ошибки | * code - код ошибки | ||
| - | ==== Статусы ответа: ==== | + | ==== Статусы ответа ==== |
| * 200 - запрос выполнен корректно | * 200 - запрос выполнен корректно | ||
| * 400 - возникла ошибка при обработке запроса | * 400 - возникла ошибка при обработке запроса | ||
| - | ==== Коды ошибок: ==== | + | ==== Коды ошибок ==== |
| * 1 - Token not set | * 1 - Token not set | ||
| Строка 69: | Строка 91: | ||
| * 4 - Not access for dataset | * 4 - Not access for dataset | ||
| * 5 - Inavlid request | * 5 - Inavlid request | ||
| + | ==== Пример ответа==== | ||
| + | < | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | </ | ||
| + | < | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | </ | ||
| ====== Сообщения от сервера ====== | ====== Сообщения от сервера ====== | ||
ru/airlay/api/air-lay-web-socket.1711944093.txt.gz · Последнее изменение: 2024/04/01 11:01 — Рыков Павел
Инструменты страницы
Если не указано иное, содержимое этой вики предоставляется на условиях следующей лицензии: CC Attribution-Share Alike 4.0 International
