Echo Web Server

Echo Web Server

Введение

Веб -сервер C ++ 20 Echo, работающий на Linux .

Если пользователь вводит имя <user> и сообщение <msg> , сервер ответит <user> said "<msg>" .

• Используя систему конфигурации на основе YAML , поддерживая уведомление об изменениях значений, контейнеров и пользовательских типов.
• Используя настраиваемую систему журнала, поддерживая синхронные и асинхронные режимы.
• Использование автоматических буферов для хранения данных.
• Использование государственной машины для разбора HTTP -запросов.
• Используя пул потоков, эполл и не блокирующие розетки для обработки HTTP- запросов.
• Использование системы таймеров, основанной на MIN-HEAP, чтобы закрыть временные соединения.
• ЕДИНИЦЫ ИСПОЛЬЗОВАНИЕ GOOGLEST .

Начиная

Предварительные условия

• Установите и запустите Docker .

Здание

Установите расположение в папку проекта и запустите:

docker image build . -t < image >

<image> следует заменить на пользовательское имя изображения Docker .

Заводящие тесты

docker container run < image > ctest --test-dir .. -VV

Использование

Конфигурация

config.yaml - конфигурация по умолчанию. Он будет скопирован в Docker во время здания.

 server :
  # The TCP listening port.
  port : 10000
  # The website folder.
  asset_folder : " assets "
  # The maximum alive time for client timers (in seconds).
  # When a client's timer reaches zero and it has no activity, it will disconnect.
  alive_time : 60
loggers :
  - name : root
    level : info
    appenders :
      - type : stdout

Вот два способа сделать новую конфигурацию эффективной.

• Измените config.yaml и создайте новое изображение Docker .
• Введите существующий контейнер Docker и измените build/bin/config.yaml .

См. src/log/README.md для получения более подробной информации, если вы хотите изменить конфигурацию Logger.

Запуск сервера

docker container run -p < container-port > : < host-port > < image >

<container-port> должен быть равен server.port в config.yaml . <host-port> может быть любой доступный порт хост-машины. -p <container-port>:<host-port> связывает <container-port> контейнер с <host-port> хост-машины.

После того, как сервер будет запущен, откройте браузер и доступ к http://localhost:<host-port> на хост-машине, чтобы использовать его.

Вы можете запустить следующую команду и получить доступ http://localhost:10000 если вы используете конфигурацию по умолчанию.

docker container run -p 10000:10000 < image > 

Модульные тесты

Модульные тесты выполняются с использованием структуры Googletest , состоящей из публичных и частных тестов.

• Общественные тесты находятся в папке tests .
• Частные тесты находятся в той же папке, что и соответствующие модули.

Имя единичного тестового файла заканчивается _test .

Документы

Стиль комментария кода следует спецификации доксигена .

Диаграмма класса следует спецификации русалки .

Структура

 .
├── CITATION.cff
├── CMakeLists.txt
├── Dockerfile
├── LICENSE
├── README.md
├── .github
│   └── workflows
│       └── cmake-googletest.yaml
├── assets
│   ├── favicon.ico
│   ├── http-status.html
│   └── index.html
├── config.yaml
├── docs
│   └── badges
│       ├── C++.svg
│       ├── License-MIT.svg
│       ├── Linux.svg
│       ├── Made-with-CMake.svg
│       ├── Made-with-GitHub-Actions.svg
│       └── Made-with-Docker.svg
├── include
│   ├── config.h
│   ├── containers
│   │   ├── block_deque.h
│   │   ├── buffer.h
│   │   ├── epoller.h
│   │   ├── heap_timer.h
│   │   └── thread_pool.h
│   ├── http.h
│   ├── io.h
│   ├── ip.h
│   ├── log.h
│   ├── test_util.h
│   ├── util.h
│   └── web_server.h
├── src
│   ├── CMakeLists.txt
│   ├── config
│   │   ├── CMakeLists.txt
│   │   ├── README.md
│   │   └── config.cpp
│   ├── containers
│   │   ├── CMakeLists.txt
│   │   ├── buffer
│   │   │   ├── CMakeLists.txt
│   │   │   ├── README.md
│   │   │   └── buffer.cpp
│   │   ├── epoller
│   │   │   ├── CMakeLists.txt
│   │   │   └── epoller.cpp
│   │   └── thread_pool
│   │       ├── CMakeLists.txt
│   │       └── thread_pool.cpp
│   ├── http
│   │   ├── CMakeLists.txt
│   │   ├── README.md
│   │   ├── http.cpp
│   │   ├── request.cpp
│   │   ├── request.h
│   │   ├── request_test.cpp
│   │   ├── response.cpp
│   │   ├── response.h
│   │   └── response_test.cpp
│   ├── io
│   │   ├── CMakeLists.txt
│   │   ├── README.md
│   │   └── io.cpp
│   ├── ip
│   │   ├── CMakeLists.txt
│   │   ├── README.md
│   │   └── ip.cpp
│   ├── log
│   │   ├── CMakeLists.txt
│   │   ├── README.md
│   │   ├── appender.cpp
│   │   ├── config_init.cpp
│   │   ├── config_init.h
│   │   ├── config_init_test.cpp
│   │   ├── field.cpp
│   │   ├── field.h
│   │   ├── field_test.cpp
│   │   └── log.cpp
│   ├── main.cpp
│   ├── test_util
│   │   ├── CMakeLists.txt
│   │   └── test_util.cpp
│   └── util
│       ├── CMakeLists.txt
│       └── util.cpp
└── tests
    ├── CMakeLists.txt
    ├── config_test.cpp
    ├── containers
    │   ├── block_deque_test.cpp
    │   ├── buffer_test.cpp
    │   ├── heap_timer_test.cpp
    │   └── thread_pool_test.cpp
    ├── http_test.cpp
    ├── io_test.cpp
    ├── ip_test.cpp
    ├── log_test.cpp
    └── util_test.cpp

Зависимости

• Yaml-CPP
• {fmt}

Ссылки

• Вебсервер
• Силар

Лицензия

Распределено по лицензии MIT . Смотрите LICENSE для получения дополнительной информации.