Документация серверной части

Начало работы

Для использования данного проекта требуется также использовать документацию разработчика с сайта http://tucodec.com/. Библиотека VoIP, демонстрационные приложения и документация для Windows/Mac/iOS/Android находятся в разделе разработчиков на официальном сайте компании TuCodec. Серверная часть предоставляет скомпилированный исполняемый код, а клиентская часть — SDK для видеоконференций.

Адрес wiki: https://gitee.com/tucodec/relay_server/wikis

Компиляция

Структура проекта следующая:

relay_server
├─3rd внешние зависимости
│ ├─curl
│ └─libuv
├─bin исполняемые файлы
│ └─log логи
├─ide расположение файлов Visual Studio sln
├─lib библиотеки зависимостей
└─src
├─clientdemo демонстрационные приложения клиента
├─client_network модуль сетевой связи клиента
├─relay_server_main исполняемый файл отдельного узла сервера
├─relay_server_master исполняемый файл главного узла сервера
├─relay_server_sdk библиотека отдельного узла сервера
└─simple_uv библиотека обертки libuv

Метод компиляции:

Перейти в папку relay_server, выполнить make (необходимо предварительно установить cmake), что приведёт к автоматической компиляции библиотек зависимостей и кода серверной части. В результате будет создан исполняемый файл relay_server_main (узел сервера) в папке relay_server/bin.## Подробности конфигурационных файлов: Конфигурационные данные могут располагаться в произвольном порядке, каждое значение должно иметь вид slave_port=12345

Конфигурационный файл для узла сервера: slave.config

Настройки для узла сервера:

slave_ip=123.234.123.234

IP адрес TCP/UDP сокета узла сервера, используемого для связи с главным узлом и передачи своего внешнего IP адреса.

slave_port=12345

Порт TCP/UDP сокета, слушаемый узлом сервера. Если этот параметр не указан, считается, что порт равен 12345. http_validate=http://www.tucodec.com/relay_server/login URL для проверки авторизации при входе пользователя в систему. По умолчанию используется HTTP запрос, если ответ равен 0, то вход разрешён. Если параметр не указан, то все попытки входа разрешены.

master_ip=0.0.0.0

IP адрес TCP сокета главного узла сервера. Если этот параметр не указан, считается, что главного узла нет.

master_port=12345

Порт TCP сокета главного узла сервера. Если этот параметр не указан, считается, что главного узла нет.

Конфигурационный файл для главного узла сервера: master.config

Настройки для главного узла сервера:

master_ip=0.0.0.0

IP адрес TCP сокета главного узла сервера. Если этот параметр не указан, считается, что IP адрес равен 0.0.0.0. master_port=10000 Порт TCP сокета главного узла сервера. Если этот параметр не указан, считается, что порт равен 10000. slave_node=127.0.0.1;123.234.123.234 Список белых IP адресов узлов сервера, указывайте строго в формате ip1;ip2;ip3.## Безопасность сервераПо умолчанию в конфигурационных файлах сервера присутствует опция http_validate_on_login, которая указывает, как сервер проверяет возможность входа пользователя при получении запроса на вход от клиента.

Опция http_validate_on_login должна быть установлена как HTTP-интерфейс. Когда http_validate_on_login=http://www.tucodec.com/relay_server/login, то при получении запроса на вход, сервер отправляет HTTP GET-запрос следующего вида:

http://www.tucodec.com/relay_server/login?uid=xxx&sessionId=xxx

Если ответ состоит из одного символа '1', это означает разрешение на вход, а любое другое значение — запрет на вход.

Для использования других методов проверки легальности входа клиента можно переопределить функцию ValidateOnLogin класса CRelayServer в файле relay_server.h. Для этого следует самостоятельно реализовать метод авторизации.

virtual bool ValidateOnLogin(uint32_t uid1, uint32_t sessionId, std::string *url);

Запуск

Для запуска программы выполните команду ./relay_server_main в директории bin.

Скачивание клиентского SDK

На данный момент доступны версии клиентского SDK для Android, iOS, Mac OS и Windows. Ссылка для скачивания находится по адресу http://develop.tucodec.com/#/download или через официальный сайт tucodec.com. В каждом SDK содержится описание API.## Другие сведения Тестовый сервер открыт, его IP-адрес: 203.76.212.115, порт: 12345. Чтобы избежать проблем с потоками данных, пожалуйста, используйте уникальный UserID, зарегистрированный на сайте tucodec, совместно со secret и secret+1. Причины возникновения проблем с потоками данных подробно описаны в разделе «Обзор дизайна сервера» в wiki.При использовании собственного облачного сервера обычно требуется настроить безопасность, открыв доступ к необходимым TCP и UDP портам.

Номер группы QQ: 439106059