Echo Web Server

Echo Web Server

Einführung

Ein C ++ 20 Echo -Webserver, der unter Linux ausgeführt wird.

Wenn ein Benutzer einen Namen <user> und eine Nachricht <msg> eingibt, antwortet der Server mit <user> said "<msg>" .

• Verwenden eines YAML -basierten Konfigurationssystems, der die Benachrichtigung von Wertänderungen und Parsen von Containern und benutzerdefinierten Typen unterstützt.
• Verwenden eines anpassbaren Protokollierungssystems, die synchrone und asynchrone Modi unterstützt.
• Verwendung automatisch expandierbarer Puffer zum Speichern von Daten.
• Verwenden einer Zustandsmaschine, um HTTP -Anforderungen zu analysieren.
• Verwenden eines Thread-Pools eine Epoll- und nicht blockierende Sockets, um HTTP- Anforderungen zu verarbeiten.
• Verwenden eines Timer-Systems basierend auf einem Min-HEAP zum Schließen von zeitgesteuerten Verbindungen.
• Unit -Tests mit Googletest .

Erste Schritte

Voraussetzungen

• Installieren und starten Sie Docker .

Gebäude

Stellen Sie den Speicherort auf den Projektordner ein und führen Sie aus:

docker image build . -t < image >

<image> sollte durch einen benutzerdefinierten Docker -Bildnamen ersetzt werden.

Auslauftests

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

Verwendung

Konfiguration

config.yaml ist die Standardkonfiguration. Es wird während des Gebäudes an Docker kopiert.

 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

Hier sind zwei Möglichkeiten, um eine neue Konfiguration effektiv zu machen.

• Ändern Sie config.yaml und erstellen Sie ein neues Docker -Bild.
• Geben Sie einen vorhandenen Docker -Container ein und ändern Sie build/bin/config.yaml .

Weitere Informationen finden Sie unter src/log/README.md wenn Sie die Logger -Konfiguration ändern möchten.

Ausführen des Servers

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

<container-port> sollte server.port in config.yaml entsprechen. <host-port> kann jeder verfügbare Port des Host-Computers sein. -p <container-port>:<host-port> bindet <container-port> des Containers an <host-port> des Host-Computers.

Öffnen Sie nach dem Ausführen des Servers einen Browser und greifen Sie auf http://localhost:<host-port> auf dem Host-Computer, um ihn zu verwenden.

Sie können den folgenden Befehl ausführen und http://localhost:10000 zugreifen, wenn Sie die Standardkonfiguration verwenden.

docker container run -p 10000:10000 < image > 

Unit -Tests

Die Unit -Tests führen mit dem Googletest -Framework durch, bestehend aus öffentlichen und privaten Tests.

• Öffentliche Tests befinden sich im Ordner tests .
• Private Tests befinden sich im selben Ordner wie die entsprechenden Module.

Der Name einer Unit -Testdatei endet mit _test .

Unterlagen

Der Code -Kommentarstil folgt der Doxygen -Spezifikation.

Das Klassendiagramm folgt der Mermaid -Spezifikation.

Struktur

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

Abhängigkeiten

• Yaml-CPP
• {fmt}

Referenzen

• Webserver
• Sylar

Lizenz

Unter der MIT -Lizenz verteilt. Weitere Informationen finden Sie LICENSE .