Echo Web Server

Echo Server Web

Introduction

Un serveur Web C ++ 20 Echo fonctionnant sur Linux .

Si un utilisateur saisit un nom <user> et un message <msg> , le serveur répondra avec <user> said "<msg>" .

• À l'aide d'un système de configuration basé sur YAML , prenant en charge la notification des modifications de valeur et des conteneurs d'analyse et des types personnalisés.
• Utilisation d'un système de journalisation personnalisable, prenant en charge les modes synchrones et asynchrones.
• Utilisation de tampons auto-expansables pour stocker des données.
• Utilisation d'une machine d'état pour analyser les demandes HTTP .
• À l'aide d'un pool de threads, une épingle EPOLL et non bloquant pour traiter les demandes HTTP .
• Utilisation d'un système de minuterie basé sur un Min-Heap pour fermer les connexions chronométrées.
• Tests unitaires à l'aide de Googlest .

Commencer

Condition préalable

• Installez et démarrez Docker .

Bâtiment

Définissez l'emplacement sur le dossier du projet et exécutez:

docker image build . -t < image >

<image> doit être remplacé par un nom d'image Docker personnalisé.

Tests en cours d'exécution

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

Usage

Configuration

config.yaml est la configuration par défaut. Il sera copié sur Docker pendant le bâtiment.

 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

Voici deux façons de rendre une nouvelle configuration efficace.

• Changez config.yaml et créez une nouvelle image Docker .
• Entrez un conteneur Docker existant et modifiez build/bin/config.yaml .

Voir src/log/README.md pour plus de détails si vous souhaitez modifier la configuration du journal.

Exécution du serveur

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

<container-port> doit être égal à server.port dans config.yaml . <host-port> peut être n'importe quel port disponible de la machine hôte. -p <container-port>:<host-port> bind <container-port> du conteneur à <host-port> de la machine hôte.

Une fois le serveur en cours d'exécution, ouvrez un navigateur et accédez http://localhost:<host-port> sur la machine hôte pour l'utiliser.

Vous pouvez exécuter la commande suivante et accéder http://localhost:10000 si vous utilisez la configuration par défaut.

docker container run -p 10000:10000 < image > 

Tests unitaires

Les tests unitaires effectuent à l'aide du framework Googlest , composé de tests publics et privés.

• Les tests publics sont dans le dossier tests .
• Les tests privés sont dans le même dossier que les modules correspondants.

Le nom d'un fichier de test unitaire se termine par _test .

Documents

Le style de commentaire de code suit la spécification du doxygen .

Le diagramme de classe suit la spécification sirène .

Structure

 .
├── 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

Dépendances

• YAML-CPP
• {FMT}

Références

• Serveur Web
• Sylar

Licence

Distribué sous la licence du MIT . Voir LICENSE pour plus d'informations.