ChronosXYZ/Influence-cjdns
1
0
Fork 0
mirror of https://github.com/ChronosX88/Influence-cjdns.git synced 2024-09-19 11:31:31 +00:00
Code Issues Projects Releases Wiki Activity

Update API.md

Browse Source
This commit is contained in:
ChronosX88 2018-05-13 18:03:39 +03:00 committed by GitHub
parent d20b4188aa
commit 3e14163bdd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
doc/ru/API.md
View File

@ -4,28 +4,14 @@
Связь между узлами - точка-точка
GUI - Сервер ==== Сервер - GUI
GUI - API ==== API - GUI
GUI - примитивная программа под Linux/Window/Android, которая умеет отображать сообщения и обмениваться с сервером.
Сервер - как правило сидит на localhost, принимает сообщения от GUI и переправляет на другой сервер.
В Windows/Linux GUI и серверная часть могут быть объединены.
Разделение GUI и Сервера позволяет также отправлять сообщения тем, кто оффлайн (например сервер крутится на роутере и он всё время online).
На сервере также хранится история переписки.
У сервера есть список контактов (друзей), в формате:
```json
{
"адрес1": { "nick":"", "last_online":"", "last_connect":"", "can_resend":1, "key":"", "other_info":... }
...
}
```
Поле адрес - это адрес сервера, куда отправляем. Может быть как ipv4, так и ipv6 адрес в сети cjdns.
GUI - примитивная программа под Linux/Window/Android, которая умеет отображать сообщения и вызывать функции ядра (API).
API - ядро мессенджера. Достаточно подключить *main.cpp*, чтобы вызывать функции ядра.
## Протокол обмена
Обмен сообщениями ведётся по GET/POST http протоколу в формате JSON, что позволяет делать GUI прямо в браузере.
Обмен сообщениями ведётся по UDP протоколу в формате JSON.
При любой успешной отправке данных обновляем поле last_connect у контакта.
Если пришло сообщение от контакта, которого нет в адресной книге - то оно отбрасывается.
Исключения - запрос handshake.
@ -35,13 +21,13 @@ GUI - примитивная программа под Linux/Window/Android, к
Используется, чтобы установить связь с контактом. Тот кто хочет добавиться в друзья - отправляет такой запрос.
```json
{ "action":"handshake", "peerID": "*IPv6 контакта*" }
{ "peerID":"*IPv6 контакта*", "action":"handshake" }
```
ответ:
```json
{ "status": 1 }
{ "peerID":"*IPv6*", "action":"handshakeSuccess","status": 1 }
```
У другого абонента висит этот контакт в списке неавторизованных. Если он хочет его тоже добавить в друзья - отправляем ему свой handshake. Возможет вариант, когда сервер автоматически добавляет в друзья (публичный сервер для пересылки offline сообщений).