Crate docs for servers::http module

[josecelano]

Documentation for the crate::servers::http module. The HTTP tracker.

[josecelano]

Hi @da2ce7 @WarmBeer , for the time being, I'm not going to write docs for these modules:

• src/servers/http/server.rs
• src/servers/http/v1/launcher.rs

The torrust_tracker::servers::http::v1::launcher::Launcher is used only for testing, and it would be not very clear to add documentation since the test code does not appear in the documentation unless you add it as a doc comment.

Regarding the src/servers/http/server.rs, the HttpServerLauncher is not used in production either. I think the only code used in production is:

pub fn start(socket_addr: std::net::SocketAddr, tracker: Arc<Tracker>) -> impl Future<Output = hyper::Result<()>> {
    let app = router(tracker);

    let server = axum::Server::bind(&socket_addr).serve(app.into_make_service_with_connect_info::<std::net::SocketAddr>());

    server.with_graceful_shutdown(async move {
        tokio::signal::ctrl_c().await.expect("Failed to listen to shutdown signal.");
        info!("Stopping Torrust HTTP tracker server on http://{} ...", socket_addr);
    })
}

pub fn start_tls(
    socket_addr: std::net::SocketAddr,
    ssl_config: RustlsConfig,
    tracker: Arc<Tracker>,
) -> impl Future<Output = Result<(), std::io::Error>> {
    let app = router(tracker);

    let handle = Handle::new();
    let shutdown_handle = handle.clone();

    tokio::spawn(async move {
        tokio::signal::ctrl_c().await.expect("Failed to listen to shutdown signal.");
        info!("Stopping Torrust HTTP tracker server on https://{} ...", socket_addr);
        shutdown_handle.shutdown();
    });

    axum_server::bind_rustls(socket_addr, ssl_config)
        .handle(handle)
        .serve(app.into_make_service_with_connect_info::<std::net::SocketAddr>())
}

We can either:

• Change production code to mirror testing bootstrapping.
• Move the code that is only used for testing to the test mods until we start using in production.

I'd do the second after merging this PR and them and the documentation for the remaining code.