diff --git a/docs/proto/tamtam_ws.md b/docs/proto/tamtam_ws.md new file mode 100644 index 0000000..42910e6 --- /dev/null +++ b/docs/proto/tamtam_ws.md @@ -0,0 +1,29 @@ +# Описание протокола TamTam по Websocket + +## Основная информация +В веб версии мессенджера ТамТам используется протокол, работающий поверх Websocket. + +Пакеты в этом протоколе являются JSON данными, закодированными в текст (UTF-8). + +Структура пакета: +```json +{ + ver: int, + cmd: int, + seq: int, + opcode: int, + payload: {} +} +``` + +ver - версия протокола +cmd - определяет, от кого отправлен пакет. клиент - 0, сервер - 1 +seq - порядковый номер пакета (сервер дублирует его из запроса клиента) +opcode - команда +payload - полезная нагрузка команды + +## Команды протокола + +### PING (1) +Клиент отправляет пакет с командой PING и пустой нагрузкой серверу раз в x секунд. +Сервер отвечает ему тем же. \ No newline at end of file