xyphenore / web-server

A multithreaded Web server. Don't use it, it's an exercise of the Rust Book. Providing a Rust implementation and a C++ implementation.

Multithreaded Web server

Implementation of a multithreaded Web server like the exercise of the Rust Book.

Please don't use it or use it at your risks. You can use ActixWeb.

Table of contents

• Technologies
• Setup

Tech Stack

Requirements:

• Rust 2021
• Cargo 1.79.0

Setup

You can download the project and build it with Meson.

Clone the project:

git clone https://github.com/Xyphenore/web-server.git

Build it:

cargo build

Run it

cargo run

Generate the documentation

cargo doc

Open the target/doc/web_server/index.html in the directory target/doc/web_server.

cd target/doc/web_server

web-server's Issues

Update the documentation of CPP web server

After the issue #7 done. The documentation must be updated to be conform.

Make a C++ implementation

To train mutex and process in C++. Do the same exercice but in C++

Improve performance of compilation

• : Move definitions of bigger methods in cpp files.
• : Move definitions of inline smaller (one line) methods outside classes.

If some functions in tools.hpp are only used in one cpp file, move the function in the cpp file and make it static.

Parallelize the uppercase conversion

Use std::transform and std::execution::par_unseq.

Because std::transform can be parallelized instead of std::for_each that use the in-order execution.

Use traits to verify arguments at the compile time

The class NotZeroSizeT can be replaced by std::is_same<T, std::size_t> and a constexpr function to verify that the value is not 0.

Archive the project

Because the project is not maintained, the project must be archived.

Finish the refactor for Response and Request

Objects:

• Response
  • Finish the format of the outgoing string
• Request
  • Use Method and Status objects directly
• RequestHandler
  • Update to wait a Response from registered listeners
• Method
  • Don't panic when the method is built from a strinf incoming from the network, must return an error

Routes:

• Get index
  • Use the new Request
  • Return a Response
• Get Not found
  • Use the new Request
  • Return a Response

Add run guide

Add to README.md a guide to run the Rust version and CPP version of the web server.

Make is_running bool like a std::atomic_bool

Currently we use a mutex and lock it, the std::atomic_bool, simplify the logic by hiding the mutex.

Graceful shutdown

Implement the graceful shutdown of the Web server.

https://doc.rust-lang.org/book/ch20-03-graceful-shutdown-and-cleanup.html

Document the Web server

The code must be documented.

Optimize the memory usage

Restructure attributes of structs to compact the memory using alignment.

Check if the use of reference decreases the memory usage.

Make the Web server multithreaded

Currently the Web server can manage one request at time.
To increase performance and user experience, the server must use Thread to manage multiple requests.

Chapter: https://doc.rust-lang.org/book/ch20-02-multithreaded.html