Influence-cjdns/doc/ru/main.md

146 lines
5.8 KiB
Markdown
Raw Normal View History

2018-05-15 13:23:54 +00:00
# Общая документация
2018-05-09 11:39:18 +00:00
2018-05-15 13:25:00 +00:00
## Структура мессенджера
2018-05-09 12:27:25 +00:00
2018-05-09 11:39:18 +00:00
Связь между узлами - точка-точка
2018-05-13 15:03:39 +00:00
GUI - API ==== API - GUI
2018-05-09 11:39:18 +00:00
2018-05-13 17:04:00 +00:00
GUI - примитивная программа под Linux/Window/Android, которая умеет отображать сообщения и вызывать функции ядра (API).
2018-05-15 13:25:00 +00:00
API - ядро мессенджера. Достаточно подключить *main.cpp*, чтобы вызывать функции ядра. Такая структура позволяет писать какие угодно клиенты.
2018-05-09 11:39:18 +00:00
## Протокол обмена
2018-05-09 12:27:25 +00:00
2018-05-13 15:03:39 +00:00
Обмен сообщениями ведётся по UDP протоколу в формате JSON.
2018-05-09 11:39:18 +00:00
При любой успешной отправке данных обновляем поле last_connect у контакта.
2018-05-09 12:14:45 +00:00
Если пришло сообщение от контакта, которого нет в адресной книге - то оно отбрасывается.
Исключения - запрос handshake.
2018-05-09 11:39:18 +00:00
2018-05-09 12:31:17 +00:00
### Добавление в друзья
Используется, чтобы установить связь с контактом. Тот кто хочет добавиться в друзья - отправляет такой запрос.
2018-05-09 12:27:25 +00:00
2018-05-09 11:54:44 +00:00
```json
2018-05-15 11:17:46 +00:00
{
"peerID":"*IPv6 контакта*",
"action":"handshake"
}
2018-05-09 11:39:18 +00:00
```
2018-05-09 12:27:25 +00:00
2018-05-09 12:31:17 +00:00
ответ:
2018-05-09 12:27:25 +00:00
2018-05-09 11:54:44 +00:00
```json
2018-05-15 11:17:46 +00:00
{
"peerID":"*IPv6*",
"action":"handshakeSuccess",
"status": true
}
2018-05-09 11:39:18 +00:00
```
2018-05-09 12:27:25 +00:00
2018-05-09 12:14:45 +00:00
У другого абонента висит этот контакт в списке неавторизованных. Если он хочет его тоже добавить в друзья - отправляем ему свой handshake. Возможет вариант, когда сервер автоматически добавляет в друзья (публичный сервер для пересылки offline сообщений).
2018-05-09 11:39:18 +00:00
2018-05-09 12:23:21 +00:00
### Отправка сообщения
Структура сообщения в JSON:
2018-05-09 11:54:44 +00:00
```json
2018-05-15 11:17:46 +00:00
{
"peerSender":"*IPv6*",
"peerReceiver":"*IPv6*",
"action":"send",
"chatID":"*Идентификатор чата, у обоих он одинаковый*",
"msgID":"*ID сообщения в чате*","msgText":"*сообщение*",
"timestamp":"*время*",
"enctype":""
}
2018-05-09 11:39:18 +00:00
```
2018-05-09 12:27:25 +00:00
2018-05-09 11:39:18 +00:00
ответ:
2018-05-09 12:27:25 +00:00
2018-05-09 11:54:44 +00:00
```json
2018-05-15 11:17:46 +00:00
{
"peerSender":"*IPv6 отправителя, т.е. кому доставили сообщение*",
"peerReceiver":"*IPv6 получателя, т.е. кто отправил сообщение*",
"action":"sendSuccess",
"chatID":"*Идентификатор чата, у обоих он одинаковый*",
"msgID":"*ID сообщения, которое доставлено, в чате*",
"status": true
}
2018-05-09 11:39:18 +00:00
```
2018-05-09 12:27:25 +00:00
2018-05-13 17:04:00 +00:00
Сообщение может должно быть зашифровано, метод шифрования указан в поле `enctype`.
2018-05-09 11:39:18 +00:00
Если нет ответа, то сохраняем сообщение у себя в истории, чтобы потом переотправить.
2018-05-13 17:04:00 +00:00
`status == true` - доставлено.
2018-05-09 11:39:18 +00:00
2018-05-09 12:23:21 +00:00
### Пинг - проверка онлайна
2018-05-13 17:04:00 +00:00
Если прошло время last_connect > 1 минуты, от отправляем запрос
2018-05-09 12:23:21 +00:00
2018-05-09 11:54:44 +00:00
```json
2018-05-15 11:17:46 +00:00
{
"peerID":"*IPv6*",
"action":"ping"
}
2018-05-09 11:39:18 +00:00
```
2018-05-09 12:27:25 +00:00
2018-05-09 11:39:18 +00:00
ответ:
2018-05-09 12:27:25 +00:00
2018-05-09 11:54:44 +00:00
```json
2018-05-15 11:17:46 +00:00
{
"peerID":"*IPv6*",
"action":"pong"
}
2018-05-09 11:39:18 +00:00
```
2018-05-13 17:11:54 +00:00
Если у нас есть сообщения для адреса и он онлайн (last_connect < 1 минуты), то передаём их.
2018-05-09 11:39:18 +00:00
Если для этого адрес в базе есть недоставленные сообщения, то отправляем такой запрос:
2018-05-09 12:23:21 +00:00
2018-05-09 11:54:44 +00:00
```json
2018-05-15 11:17:46 +00:00
{
"action":"history",
"messages":[{},{},{}...]
}
2018-05-09 11:39:18 +00:00
```
2018-05-09 12:27:25 +00:00
2018-05-09 12:23:21 +00:00
ответ:
2018-05-09 12:27:25 +00:00
2018-05-09 11:54:44 +00:00
```json
2018-05-09 11:58:38 +00:00
{ "status":[1,1,1,0,1] }
2018-05-09 11:39:18 +00:00
```
2018-05-09 12:27:25 +00:00
2018-05-09 11:39:18 +00:00
В ответ приходит массив с 1 или 0. Если 1 - сообщение сохранено успешно, 0 - ошибка и его нужно потом переотправить.
2018-05-09 12:23:21 +00:00
### Отправление сообщения для другого абонента (это нужно чтобы отправлять тем, кто в offline)
Если человек, которому мы отправляем сообщение offline - то, во-первых, оно сохраняется у себя на сервере, для последующей отправки.
Во-вторых, можно попросить какого-то друга его переотправить. Для этого выбираем случайно несколько друзей из списка контактов, у которых `can_resend == 1` и отправляем им запрос.
2018-05-09 11:39:18 +00:00
Для ретрансляции можно также использовать свой сервер в интернете, нужно просто его добавить в контакты.
2018-05-09 12:23:21 +00:00
2018-05-09 11:54:44 +00:00
```json
2018-05-15 11:17:46 +00:00
{
"peerSender":"*IPv6*",
"peerReceiver":"*IPv6*",
"action":"resend",
"chatID":"*Идентификатор чата, у обоих он одинаковый*",
"msgID":"*ID сообщения в чате*",
"msgText":"*сообщение*",
"timestamp":"*время*",
"enctype":""
}
2018-05-09 11:39:18 +00:00
```
2018-05-09 12:27:25 +00:00
2018-05-13 17:11:54 +00:00
Ответ:
2018-05-09 12:27:25 +00:00
2018-05-09 11:54:44 +00:00
```json
2018-05-15 11:17:46 +00:00
{
"peerID":"*IPv6*",
"action":"resendSuccess",
"status":true
}
2018-05-09 11:39:18 +00:00
```
2018-05-09 12:27:25 +00:00
2018-05-11 05:36:06 +00:00
Если `status == 0` - то эта нода не желает пересылать сообщения и ей повторно отправлять не нужно.
2018-05-15 13:23:54 +00:00
### Генерация любых уникальных идентификаторов (UUID)
Генерация любых уникальных идентификаторов в мессенджере осуществляется с помощью класса *QUuid* в *Qt*. Используется функция `QUuid::createUuid()` без аргументов.