Skip to content

Commit

Permalink
docs: update some UDP server comments
Browse files Browse the repository at this point in the history
  • Loading branch information
josecelano committed Jun 25, 2024
1 parent 89bb735 commit 023e49d
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 18 deletions.
18 changes: 0 additions & 18 deletions src/servers/udp/server/mod.rs
Original file line number Diff line number Diff line change
@@ -1,22 +1,4 @@
//! Module to handle the UDP server instances.
//!
//! There are two main types in this module:
//!
//! - [`UdpServer`]: a controller to start and stop the server.
//! - [`Udp`]: the server launcher.
//!
//! The `UdpServer` is an state machine for a given configuration. This struct
//! represents concrete configuration and state. It allows to start and
//! stop the server but always keeping the same configuration.
//!
//! The `Udp` is the server launcher. It's responsible for launching the UDP
//! but without keeping any state.
//!
//! For the time being, the `UdpServer` is only used for testing purposes,
//! because we want to be able to start and stop the server multiple times, and
//! we want to know the bound address and the current state of the server.
//! In production, the `Udp` launcher is used directly.

use std::fmt::Debug;

use super::RawRequest;
Expand Down
1 change: 1 addition & 0 deletions src/servers/udp/server/spawner.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
//! A thin wrapper for tokio spawn to launch the UDP server launcher as a new task.
use std::net::SocketAddr;
use std::sync::Arc;

Expand Down

0 comments on commit 023e49d

Please sign in to comment.