aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFuwn <[email protected]>2021-05-23 14:10:13 +0000
committerFuwn <[email protected]>2021-05-23 14:10:13 +0000
commitf26af58740ad08bc0bccccd51ea981abcadc23fc (patch)
tree84459369fc636cbf358d3d4cbc0760dac9dd1b03
parentdocs(global): more documentation (diff)
downloadwhirl-f26af58740ad08bc0bccccd51ea981abcadc23fc.tar.xz
whirl-f26af58740ad08bc0bccccd51ea981abcadc23fc.zip
docs(server): minor doc changes
-rw-r--r--crates/whirl_server/src/distributor.rs10
-rw-r--r--crates/whirl_server/src/hub.rs7
2 files changed, 9 insertions, 8 deletions
diff --git a/crates/whirl_server/src/distributor.rs b/crates/whirl_server/src/distributor.rs
index 0d99c66..3aae901 100644
--- a/crates/whirl_server/src/distributor.rs
+++ b/crates/whirl_server/src/distributor.rs
@@ -1,15 +1,15 @@
// Copyleft (ɔ) 2021-2021 The Whirlsplash Collective
// SPDX-License-Identifier: GPL-3.0-only
-//! The distributor functions as bare-minimal
+//! The Distributor functions as bare-minimal
//! [AutoServer](http://dev.worlds.net/private/GammaDocs/WorldServer.html#AutoServer).
//!
-//! It intercepts a client and distributes it to a
+//! The Distributor intercepts a client on initial connection and distributes it
+//! to a
//! [RoomServer](http://dev.worlds.net/private/GammaDocs/WorldServer.html#RoomServer).
//!
-//! This is not meant to be a high performant section of code as the distributor
-//! is only meant to handle the initial and brief session initialization of the
-//! client.
+//! This is not meant to be a high focus module as the Distributor is only meant
+//! to handle the initial and brief session initialization of the client.
use std::{error::Error, net::SocketAddr, sync::Arc};
diff --git a/crates/whirl_server/src/hub.rs b/crates/whirl_server/src/hub.rs
index 5bbc36a..10f3518 100644
--- a/crates/whirl_server/src/hub.rs
+++ b/crates/whirl_server/src/hub.rs
@@ -1,11 +1,12 @@
// Copyleft (ɔ) 2021-2021 The Whirlsplash Collective
// SPDX-License-Identifier: GPL-3.0-only
-//! The hub functions as a
+//! The Hub functions as a
//! [RoomServer](http://dev.worlds.net/private/GammaDocs/WorldServer.html#AutoServer).
//!
-//! The RoomServer is responsible for handling just about every request from the
-//! client after they have been redirected to a room (hub).
+//! A RoomServer is responsible for handling just about every request from the
+//! client after they have been redirected to a room (Hub) and finished their
+//! business with the Distributor (AutoServer).
use std::{error::Error, net::SocketAddr, sync::Arc};