Total Kontrol/TKT/Протокол обмена с демоном: различия между версиями

Материал из KONANlabs
Перейти к: навигация, поиск
Строка 53: Строка 53:
 
<CRLF></pre>
 
<CRLF></pre>
  
Пакет обновления может содержать данные для неограниченного количества видимых элементов:
+
Пакет обновления, в отличие от версии 1.0, тоже может содержать данные только для одного видимого элемента:
 
<pre>UPDATE[:клиент|:группа]<CRLF>
 
<pre>UPDATE[:клиент|:группа]<CRLF>
 
<id элемента><CRLF>
 
<id элемента><CRLF>
Строка 60: Строка 60:
 
...
 
...
 
<параметр n><CRLF>
 
<параметр n><CRLF>
<id элемента><CRLF>
 
<кол-во параметров><CRLF>
 
<параметр 1><CRLF>
 
...
 
<параметр n><CRLF>
 
...
 
...
 
...
 
 
<CRLF></pre>
 
<CRLF></pre>
  
 
В данных обновления видимого элемента первая строка - всегда видимое состояние, может принимать одно из определённых в XML числовых значений, invisible и unavailable (состояние unavailable также должно быть определено в XML).
 
В данных обновления видимого элемента первая строка - всегда видимое состояние, может принимать одно из определённых в XML числовых значений, invisible и unavailable (состояние unavailable также должно быть определено в XML).
  
Сервер может отправить демону запрос на обновление в случае смены страницы (демон может помнить, у кого какая страница открыта и фильтровать текущие обновления), а также когда клиент подключился к серверу, в этом случае также требуется обновить все видимые элементы страницы. Id страницы указывается через пробел после UPDATE:
+
Сервер может отправить демону запрос на обновление в случае, когда клиент подключился к серверу:
UPDATE[:клиент][ страница]<CRLF>
+
<pre>UPDATE[:клиент]<CRLF>
<CRLF>
+
<CRLF></pre>
 +
 
 +
Если клиент является членом одной или нескольких групп, сервер отправляет аналогичные запросы обновлений для каждой группы, в которую включен клиент.
  
 
== Идентификация клиентов ==
 
== Идентификация клиентов ==

Версия 20:58, 18 июня 2019

Описание протокола 1.0

Протокол однонаправленный, от страницы к демону. На любое действие пользователя страница формирует событие. При отсутствии событий страница отправляет запросы на обновление через заданный промежуток времени (атрибут refresh элемента daemon).

Пакет представляет собой серию текстовых строк, завершаемую пустой строкой (два CRLF в конце пакета). После передачи любого пакета (событие или обновление) страница не закрывает соединение, демон передаёт данные обновления состояния видимых элементов и закрывает соединение сам. Страница закрывает соединение при отсутствии ответа от демона в течение периода eventrate страницы (атрибут элемента daemon).

Пакет может содержать кадры информации об одном или нескольких видимых элементах. Кадр выглядит следующим образом:

<id видимого элемента><CRLF>
<количество параметров><CRLF>
<параметр 1><CRLF>
....
<параметр n><CRLF>

Количество и назначение каждого параметра определяется типом видимого элемента (см. Формат XML файла). Количество кадров в пакете не ограничено.

Обновления

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

UPDATE <время> <id страницы><CRLF>
<CRLF>

Время - внутренний счётчик демона, он отдаёт его значение с каждым пакетом данных обновления. Если страница только что открылась - она передаёт демону время 1, демон обновляет всё что есть.

Ответ демона начинается со строки с текущим счётчиком времени, затем (при наличии необновлённых данных) следуют кадры обновления.

События

Для исключения перегрузки клиентской машины, сервера и локальной сети частота отправки событий ограничивается атрибутом eventrate элемента daemon. В период ожидания после отправки события страница не формирует новые события, но отслеживает изменения состояния элементов, по истечении периода ожидания отправляет событие с состоянием изменившихся элементов на момент отправки. Как и обновления, пакет события может содержать кадры для нескольких видимых элементов, с которыми произошли события за период ожидания. Пакет события:

EVENT<CRLF>
<кадр>
[<кадр>]
[...   ]
[<кадр>]
<CRLF>

Описание протокола 2.0

Обмен данными

Отличается от 1.0 тем, что все клиенты поддерживают с сервером постоянное соединение. Кроме того, добавлена система идентификации клиентских устройств. Обмен данными для видимых элементов остался прежним, добавились только средства идентификации. После слов EVENT и UPDATE через двоеточие указываются номера клиентов:

  • EVENT - событие от неидентифицированного клиента
  • EVENT:1 - событие от клиента № 1

Постоянное соединение отменяет необходимость в циклическом опросе со стороны клиентов: демон сам выдаёт обновления видимых элементов в нужный момент. В отличии от версии 1.0, каждый пакет обновления демон предваряет строкой UPDATE, в которой аналогично EVENT может быть указан номер клиента или группа клиентов (UPDATE:G1). Предопределена группа 0 - все зарегистрированные клиенты.

Пакет события выглядит следующим образом (в одном пакете - строго одно событие от одного управляющего элемента):

EVENT[:клиент]<CRLF>
<id элемента><CRLF>
<кол-во параметров><CRLF>
<параметр 1><CRLF>
...
<параметр n><CRLF>
<CRLF>

Пакет обновления, в отличие от версии 1.0, тоже может содержать данные только для одного видимого элемента:

UPDATE[:клиент|:группа]<CRLF>
<id элемента><CRLF>
<кол-во параметров><CRLF>
<параметр 1><CRLF>
...
<параметр n><CRLF>
<CRLF>

В данных обновления видимого элемента первая строка - всегда видимое состояние, может принимать одно из определённых в XML числовых значений, invisible и unavailable (состояние unavailable также должно быть определено в XML).

Сервер может отправить демону запрос на обновление в случае, когда клиент подключился к серверу:

UPDATE[:клиент]<CRLF>
<CRLF>

Если клиент является членом одной или нескольких групп, сервер отправляет аналогичные запросы обновлений для каждой группы, в которую включен клиент.

Идентификация клиентов

Клиент регистрируется на сервере веб-интерфейса однократно, вручную, открытием URL веб-интерфейса с параметром ?setid=<id>. Если вместо <id> указать delete - привязка удаляется. Если поступает запрос на привязку к id, который уже есть в базе - старая привязка удаляется, к этому id привязывается новый клиент. Идентификаторы клиентов могут быть только числовыми.

Если клиент зарегистрирован, в пакете EVENT все идентификаторы указываются в нотации :<клиент>:<элемент> (:12:/~dsp/gain/in/1). В одном пакете EVENT могут быть кадры от разных клиентов.

В запросе на обновление от зарегистрированного клиента id страницы дополняется id клиента аналогичным образом (UPDATE 12345 :12:page_main). В ответе на такой пакет идентификаторы элементов указываются без id клиента.

Клиенты могут объединяться в группы. Регистрация клиента в группе - запрос с параметром ?groupadd=<id>, исключение клиента из группы - ?groupremove=<id>. Идентификатор группы может быть только числовым. Один клиент может быть в нескольких группах.

Предопределена группа 0 - все зарегистрированные клиенты. Удалить клиента из неё нельзя.

В протоколе обмена группы обозначаются так же, как клиенты, только id группы предваряется буквой G (:G0:/~dsp/gain/in/1).

Проверка связи

Для поддержания постоянного соединения сервер (апач) может отправлять демону пакет PING<CRLF><CRLF>, демон отвечает PONG<CRLF><CRLF>.

?

возможность постоянного соединения страницы с сервером по websocket. Предназначен для клиентов-киосков, в которых пользователь не может ни закрыть, ни свернуть веб-интерфейс.