mirror of
https://github.com/ChronosX88/Influence-cjdns.git
synced 2024-11-08 17:01:00 +00:00
набросок API
This commit is contained in:
parent
17c2cf1c99
commit
2239b913c5
86
API.md
Normal file
86
API.md
Normal file
@ -0,0 +1,86 @@
|
||||
P2P-мессенджер. Протокол обмена
|
||||
===============================
|
||||
|
||||
## Структура сети:
|
||||
Связь между узлами - точка-точка
|
||||
|
||||
GUI - Сервер ==== Сервер - GUI
|
||||
|
||||
GUI - примитивная программа под Linux/Window/Android, которая умеет отображать сообщения и обмениваться с сервером.
|
||||
Сервер - как правило сидит на localhost, принимает сообщения от GUI и переправляет на другой сервер.
|
||||
В Windows/Linux GUI и серверная часть могут быть объединены.
|
||||
Разделение GUI и Сервера позволяет также отправлять сообщения тем, кто оффлайн (например сервер крутится на роутере и он всё время online).
|
||||
На сервере также хранится история переписки.
|
||||
|
||||
У сервера есть список контактов (друзей), в формате:
|
||||
```
|
||||
{
|
||||
"адрес1": {nick: "", last_online: "", last_connect: "", can_resend: 1, key: "", other_info:... }
|
||||
...
|
||||
}
|
||||
```
|
||||
Поле адрес - это адрес сервера, куда отправляем. Может быть как ipv4, так и ipv6 адрес в сети cjdns.
|
||||
|
||||
|
||||
## Протокол обмена
|
||||
Обмен сообщениями ведётся по GET/POST http протоколу в формате JSON, что позволяет делать GUI прямо в браузере.
|
||||
При любой успешной отправке данных обновляем поле last_connect у контакта.
|
||||
Во всех сообщениях нужно указывать ключ, если он не подойдёт - то сообщение отбрасывается.
|
||||
|
||||
1. Добавление в друзья
|
||||
Используется, чтобы установить связь с контактом. Для этого запрашиваем у него ключ доступа, предварительно отправив свой.
|
||||
```
|
||||
{action: "handshake", key: "пароль"}
|
||||
```
|
||||
ответ
|
||||
```
|
||||
{status: 1}
|
||||
```
|
||||
Когда один отправил запрос - то второй может отправить свой ключ и тогда сервера смогут общаться друг с другом.
|
||||
|
||||
2. Отправка сообщения:
|
||||
```
|
||||
{action:"send", from: "адрес", to: "адрес", message: "сообщение", timestamp: "время", enctype: "", key: "" }
|
||||
```
|
||||
ответ:
|
||||
```
|
||||
{status: 1}
|
||||
```
|
||||
Сообщение может быть зашифровано, метод шифрования в поле enctype.
|
||||
Если нет ответа, то сохраняем сообщение у себя в истории, чтобы потом переотправить.
|
||||
`status==1` - доставлено, другой - недоставлено (помечаем как недоставлено
|
||||
|
||||
3. Пинг - проверка онлайн
|
||||
Если прошло время больше чем last_connect + 1 минута, от отправляем запрос
|
||||
```
|
||||
{action: "ping"}
|
||||
```
|
||||
ответ:
|
||||
```
|
||||
{action: "pong"}
|
||||
```
|
||||
|
||||
4. Если у нас есть сообщения для адреса и он онлайн (last_connect < 1 минуты), то передаём их
|
||||
Если для этого адрес в базе есть недоставленные сообщения, то отправляем такой запрос:
|
||||
```
|
||||
{action: "history", messages:[{},{},{}...]}
|
||||
```
|
||||
ответ
|
||||
```
|
||||
{status:[1,1,1,0,1]}
|
||||
```
|
||||
В ответ приходит массив с 1 или 0. Если 1 - сообщение сохранено успешно, 0 - ошибка и его нужно потом переотправить.
|
||||
|
||||
5. Отправить сообщение для другого абонента (это нужно чтобы отправлять тем, кто в offline)
|
||||
Если человек, которому мы отправляем сообщение offline - то во-первых оно сохраняется у себя на сервере, для последующей отправки.
|
||||
Во-вторых, можно попросить какого-то друга его переотправить. Для этого выбираем случайно несколько друзей из списка контактов, у которых can_resend == 1 и отправляем им запрос.
|
||||
Для ретрансляции можно также использовать свой сервер в интернете, нужно просто его добавить в контакты.
|
||||
```
|
||||
{action: "resend", ...}
|
||||
```
|
||||
Параметры такие же как и для send
|
||||
ответ
|
||||
```
|
||||
{status: 1}
|
||||
```
|
||||
Если status: 0 - то эта нода не желает пересылать сообщения и ей повторно отправлять не нужно.
|
Loading…
Reference in New Issue
Block a user