Echo Web Server

Echo Web Server

Introdução

Um servidor Web C ++ 20 eco em execução no Linux .

Se um usuário inserir um nome <user> e uma mensagem <msg> , o servidor responderá com <user> said "<msg>" .

• Usando um sistema de configuração baseado em YAML , suportando a notificação de alterações de valor e analisando contêineres e tipos personalizados.
• Usando um sistema de log personalizável, suportando modos síncronos e assíncronos.
• Usando buffers expressáveis ​​automaticamente para armazenar dados.
• Usando uma máquina de estado para analisar solicitações HTTP .
• Usando um pool de threads, um Epoll e soquetes não bloqueadores para processar solicitações HTTP .
• Usando um sistema de timer baseado em um minheto para fechar as conexões programadas.
• Testes de unidade usando GoogleTest .

Começando

Pré -requisitos

• Instale e inicie o Docker .

Prédio

Defina o local para a pasta do projeto e execute:

docker image build . -t < image >

<image> deve ser substituído por um nome de imagem personalizado do Docker .

Testes de execução

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

Uso

Configuração

config.yaml é a configuração padrão. Será copiado para o Docker durante o prédio.

 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

Aqui estão duas maneiras de tornar uma nova configuração eficaz.

• Alterar config.yaml e construa uma nova imagem do Docker .
• Digite um contêiner do docker existente e altere build/bin/config.yaml .

Consulte src/log/README.md para obter mais detalhes se desejar alterar a configuração do Logger.

Executando o servidor

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

<container-port> deve ser igual ao server.port em config.yaml . <host-port> pode ser qualquer porta disponível da máquina host. -p <container-port>:<host-port> liga <container-port> do contêiner para <host-port> da máquina host.

Depois que o servidor estiver em execução, abra um navegador e acesse http://localhost:<host-port> na máquina host para usá-lo.

Você pode executar o seguinte comando e acessar http://localhost:10000 se estiver usando a configuração padrão.

docker container run -p 10000:10000 < image > 

Testes de unidade

Os testes de unidade executam o desempenho da estrutura GoogleTest , composta por testes públicos e privados.

• Os testes públicos estão na pasta de tests .
• Os testes privados estão na mesma pasta que os módulos correspondentes.

O nome de um arquivo de teste de unidade termina com _test .

Documentos

O estilo de comentário do código segue a especificação doxygen .

O diagrama de classes segue a especificação da sereia .

Estrutura

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

Dependências

• YAML-CPP
• {fmt}

Referências

• Servidor da web
• Sylar

Licença

Distribuído sob a licença do MIT . Consulte LICENSE para obter mais informações.