remove outdated docs

Co-authored-by: Flori <39242991+bitfl0wer@users.noreply.github.com>

examples/voice_simple/src/main.rs

@@ -40,7 +40,7 @@ use tokio::sync::{Mutex, RwLock};
 extern crate chorus;
 extern crate tokio;
 
-/// Handles inbetween connections between the gateway and udp modules
+/// Handles in between connections between the gateway and UDP modules
 #[derive(Debug, Clone)]
 pub struct VoiceHandler {
     pub voice_gateway_connection: Arc<Mutex<Option<VoiceGatewayHandle>>>,
@@ -49,7 +49,7 @@ pub struct VoiceHandler {
 }
 
 impl VoiceHandler {
-    /// Creates a new voicehandler, only initializing the data
+    /// Creates a new [VoiceHandler], only initializing the data
     pub fn new() -> VoiceHandler {
         Self {
             data: Arc::new(RwLock::new(VoiceData::default())),
@@ -66,7 +66,7 @@ impl Default for VoiceHandler {
 }
 
 #[async_trait]
-// On [VoiceServerUpdate] we get our starting data and url for the voice gateway server.
+// On [VoiceServerUpdate] we get our starting data and URL for the voice gateway server.
 impl Observer<VoiceServerUpdate> for VoiceHandler {
     async fn update(&self, data: &VoiceServerUpdate) {
         let mut data_lock = self.data.write().await;
@@ -121,7 +121,7 @@ impl Observer<VoiceServerUpdate> for VoiceHandler {
 }
 
 #[async_trait]
-// On [VoiceReady] we get info for establishing a UDP connection, and we immedietly need said UDP
+// On [VoiceReady] we get info for establishing a UDP connection, and we immediately need said UDP
 // connection for ip discovery.
 impl Observer<VoiceReady> for VoiceHandler {
     async fn update(&self, data: &VoiceReady) {

src/errors.rs

@@ -140,7 +140,7 @@ custom_error! {
     pub VoiceUdpError
 
     // General errors
-    BrokenSocket{error: String} = "Could not write / read from udp socket: {error}",
+    BrokenSocket{error: String} = "Could not write / read from UDP socket: {error}",
     NoData = "We have not set received the necessary data to perform this operation.",
 
     // Encryption errors
@@ -151,8 +151,8 @@ custom_error! {
     FailedNonceGeneration{error: String} = "Tried to generate nonce, but failed due to error: {error}.",
 
     // Errors when initiating a socket connection
-    CannotBind{error: String} = "Cannot bind socket due to a udp error: {error}",
-    CannotConnect{error: String} = "Cannot connect due to a udp error: {error}",
+    CannotBind{error: String} = "Cannot bind socket due to a UDP error: {error}",
+    CannotConnect{error: String} = "Cannot connect due to a UDP error: {error}",
 }
 
 impl WebSocketEvent for VoiceUdpError {}

src/gateway/backends/tungstenite.rs

@@ -27,8 +27,16 @@ impl TungsteniteBackend {
         websocket_url: &str,
     ) -> Result<(TungsteniteSink, TungsteniteStream), crate::errors::GatewayError> {
         let mut roots = rustls::RootCertStore::empty();
-        for cert in rustls_native_certs::load_native_certs().expect("could not load platform certs")
-        {
+        let certs = rustls_native_certs::load_native_certs();
+
+        if let Err(e) = certs {
+            log::error!("Failed to load platform native certs! {:?}", e);
+            return Err(GatewayError::CannotConnect {
+                error: format!("{:?}", e),
+            });
+        }
+
+        for cert in certs.unwrap() {
             roots.add(&rustls::Certificate(cert.0)).unwrap();
         }
         let (websocket_stream, _) = match connect_async_tls_with_config(

src/gateway/gateway.rs

@@ -26,6 +26,7 @@ pub struct Gateway {
     websocket_send: Arc<Mutex<Sink>>,
     websocket_receive: Stream,
     kill_send: tokio::sync::broadcast::Sender<()>,
+    kill_receive: tokio::sync::broadcast::Receiver<()>,
     store: Arc<Mutex<HashMap<Snowflake, Arc<RwLock<ObservableObject>>>>>,
     url: String,
 }
@@ -75,6 +76,7 @@ impl Gateway {
             websocket_send: shared_websocket_send.clone(),
             websocket_receive,
             kill_send: kill_send.clone(),
+            kill_receive: kill_send.subscribe(),
             store: store.clone(),
             url: websocket_url.clone(),
         };
@@ -99,11 +101,19 @@ impl Gateway {
     }
 
     /// The main gateway listener task;
-    ///
-    /// Can only be stopped by closing the websocket, cannot be made to listen for kill
     pub async fn gateway_listen_task(&mut self) {
         loop {
-            let msg = self.websocket_receive.next().await;
+            let msg;
+
+            tokio::select! {
+                Ok(_) = self.kill_receive.recv() => {
+                    log::trace!("GW: Closing listener task");
+                    break;
+                }
+                message = self.websocket_receive.next() => {
+                    msg = message;
+                }
+            }
 
             // PRETTYFYME: Remove inline conditional compiling
             #[cfg(not(target_arch = "wasm32"))]

src/gateway/heartbeat.rs

@@ -77,11 +77,6 @@ impl HeartbeatHandler {
         let mut last_seq_number: Option<u64> = None;
 
         loop {
-            if kill_receive.try_recv().is_ok() {
-                trace!("GW: Closing heartbeat task");
-                break;
-            }
-
             let timeout = if last_heartbeat_acknowledged {
                 heartbeat_interval
             } else {
@@ -115,6 +110,10 @@ impl HeartbeatHandler {
                         }
                     }
                 }
+                Ok(_) = kill_receive.recv() => {
+                    log::trace!("GW: Closing heartbeat task");
+                    break;
+                }
             }
 
             if should_send {

src/types/events/voice_gateway/mod.rs

@@ -61,7 +61,7 @@ pub struct VoiceGatewayReceivePayload<'a> {
 
 impl<'a> WebSocketEvent for VoiceGatewayReceivePayload<'a> {}
 
-/// The modes of encryption available in voice udp connections;
+/// The modes of encryption available in voice UDP connections;
 ///
 /// Not all encryption modes are implemented; it is generally recommended
 /// to use either [[VoiceEncryptionMode::Xsalsa20Poly1305]] or

src/types/events/voice_gateway/ready.rs

@@ -12,7 +12,7 @@ use super::VoiceEncryptionMode;
 #[derive(Debug, Deserialize, Serialize, Clone, PartialEq, Eq)]
 /// The voice gateway's ready event;
 ///
-/// Gives the user info about the udp connection ip and port, srrc to use,
+/// Gives the user info about the UDP connection IP and port, srrc to use,
 /// available encryption modes and other data.
 ///
 /// Sent in response to an Identify event.
@@ -23,7 +23,7 @@ pub struct VoiceReady {
     pub ssrc: u32,
     pub ip: Ipv4Addr,
     pub port: u16,
-    /// The available encryption modes for the udp connection
+    /// The available encryption modes for the UDP connection
     pub modes: Vec<VoiceEncryptionMode>,
     #[serde(default)]
     pub experiments: Vec<String>,

src/types/events/voice_gateway/select_protocol.rs

@@ -34,7 +34,7 @@ pub enum VoiceProtocol {
     #[default]
     /// Sending data via UDP, documented and the only protocol chorus supports.
     Udp,
-    // Possible value, yet NOT RECOMMENED, AS CHORUS DOES NOT SUPPORT WEBRTC
+    // Possible value, yet NOT RECOMMENDED, AS CHORUS DOES NOT SUPPORT WEBRTC
     //Webrtc,
 }
 
@@ -43,9 +43,9 @@ pub enum VoiceProtocol {
 ///
 /// See <https://discord-userdoccers.vercel.app/topics/voice-connections#protocol-data-structure>
 pub struct SelectProtocolData {
-    /// Our external ip we got from ip discovery
+    /// Our external IP we got from IP discovery
     pub address: String,
-    /// Our external udp port we got from id discovery
+    /// Our external UDP port we got from IP discovery
     pub port: u16,
     /// The mode of encryption to use
     pub mode: VoiceEncryptionMode,

src/types/events/voice_gateway/speaking.rs

@@ -9,7 +9,7 @@ use crate::types::{Snowflake, WebSocketEvent};
 
 /// Event that tells the server we are speaking;
 ///
-/// Essentially, what allows us to send udp data and lights up the green circle around your avatar.
+/// Essentially, what allows us to send UDP data and lights up the green circle around your avatar.
 ///
 /// See <https://discord-userdoccers.vercel.app/topics/voice-connections#speaking-structure>
 #[derive(Debug, Deserialize, Serialize, Clone, Default)]

src/voice/gateway/backends/tungstenite.rs

@@ -26,8 +26,16 @@ impl TungsteniteBackend {
         websocket_url: &str,
     ) -> Result<(TungsteniteSink, TungsteniteStream), crate::errors::VoiceGatewayError> {
         let mut roots = rustls::RootCertStore::empty();
-        for cert in rustls_native_certs::load_native_certs().expect("could not load platform certs")
-        {
+        let certs = rustls_native_certs::load_native_certs();
+
+        if let Err(e) = certs {
+            log::error!("Failed to load platform native certs! {:?}", e);
+            return Err(VoiceGatewayError::CannotConnect {
+                error: format!("{:?}", e),
+            });
+        }
+
+        for cert in certs.unwrap() {
             roots.add(&rustls::Certificate(cert.0)).unwrap();
         }
         let (websocket_stream, _) = match connect_async_tls_with_config(

src/voice/gateway/gateway.rs

@@ -37,6 +37,7 @@ pub struct VoiceGateway {
     websocket_send: Arc<Mutex<Sink>>,
     websocket_receive: Stream,
     kill_send: tokio::sync::broadcast::Sender<()>,
+    kill_receive: tokio::sync::broadcast::Receiver<()>,
 }
 
 impl VoiceGateway {
@@ -89,6 +90,7 @@ impl VoiceGateway {
             websocket_send: shared_websocket_send.clone(),
             websocket_receive,
             kill_send: kill_send.clone(),
+            kill_receive: kill_send.subscribe(),
         };
 
         // Now we can continuously check for messages in a different task, since we aren't going to receive another hello
@@ -110,11 +112,19 @@ impl VoiceGateway {
     }
 
     /// The main gateway listener task;
-    ///
-    /// Can only be stopped by closing the websocket, cannot be made to listen for kill
     pub async fn gateway_listen_task(&mut self) {
         loop {
-            let msg = self.websocket_receive.next().await;
+            let msg;
+
+            tokio::select! {
+                Ok(_) = self.kill_receive.recv() => {
+                    log::trace!("VGW: Closing listener task");
+                    break;
+                }
+                message = self.websocket_receive.next() => {
+                    msg = message;
+                }
+            }
 
             // PRETTYFYME: Remove inline conditional compiling
             #[cfg(not(target_arch = "wasm32"))]

src/voice/gateway/handle.rs

@@ -97,7 +97,7 @@ impl VoiceGatewayHandle {
 
     /// Closes the websocket connection and stops all gateway tasks;
     ///
-    /// Esentially pulls the plug on the voice gateway, leaving it possible to resume;
+    /// Essentially pulls the plug on the voice gateway, leaving it possible to resume;
     pub async fn close(&self) {
         self.kill_send.send(()).unwrap();
         self.websocket_send.lock().await.close().await.unwrap();

src/voice/gateway/heartbeat.rs

@@ -98,11 +98,6 @@ impl VoiceHeartbeatHandler {
         let mut nonce: u64 = starting_nonce;
 
         loop {
-            if kill_receive.try_recv().is_ok() {
-                trace!("VGW: Closing heartbeat task");
-                break;
-            }
-
             let timeout = if last_heartbeat_acknowledged {
                 heartbeat_interval
             } else {
@@ -136,6 +131,10 @@ impl VoiceHeartbeatHandler {
                         }
                     }
                 }
+                Ok(_) = kill_receive.recv() => {
+                    log::trace!("VGW: Closing heartbeat task");
+                    break;
+                }
             }
 
             if should_send {

src/voice/gateway/message.rs

@@ -4,7 +4,7 @@
 
 use crate::{errors::VoiceGatewayError, types::VoiceGatewayReceivePayload};
 
-/// Represents a messsage received from the voice websocket connection.
+/// Represents a message received from the voice websocket connection.
 ///
 /// This will be either a [VoiceGatewayReceivePayload], containing voice gateway events, or a [VoiceGatewayError].
 ///
@@ -14,7 +14,7 @@ pub struct VoiceGatewayMessage(pub String);
 
 impl VoiceGatewayMessage {
     /// Parses the message as an error;
-    /// Returns the error if succesfully parsed, None if the message isn't an error
+    /// Returns the error if successfully parsed, None if the message isn't an error
     pub fn error(&self) -> Option<VoiceGatewayError> {
         // Some error strings have dots on the end, which we don't care about
         let processed_content = self.0.to_lowercase().replace('.', "");

src/voice/udp/handle.rs

@@ -24,7 +24,7 @@ use crate::{
 
 use super::{events::VoiceUDPEvents, RTP_HEADER_SIZE};
 
-/// Handle to a voice udp connection
+/// Handle to a voice UDP connection
 ///
 /// Can be safely cloned and will still correspond to the same connection.
 #[derive(Debug, Clone)]
@@ -45,7 +45,7 @@ impl UdpHandle {
     ///
     /// If we have not received an encryption key, this returns a [VoiceUdpError::NoKey] error.
     ///
-    /// If the Udp socket is broken, this returns a [VoiceUdpError::BrokenSocket] error.
+    /// If the UDP socket is broken, this returns a [VoiceUdpError::BrokenSocket] error.
     pub async fn send_opus_data(
         &self,
         timestamp: u32,
@@ -151,8 +151,8 @@ impl UdpHandle {
 
                 data_lock.last_udp_encryption_nonce = Some(nonce);
                 drop(data_lock);
-                // TODO: Is le correct? This is not documented anywhere
-                let mut bytes = nonce.to_le_bytes().to_vec();
+                // TODO: Is big endian correct? This is not documented anywhere
+                let mut bytes = nonce.to_be_bytes().to_vec();
 
                 // This is 4 bytes, it has to be a different size, appends 0s
                 while bytes.len() < 24 {
@@ -212,7 +212,7 @@ impl UdpHandle {
         let mut encrypted_payload = encryption_result.unwrap();
 
         // Append the nonce bytes, if needed
-        // All other encryption modes have an explicit nonce, where as Xsalsa20Poly1305
+        // All other encryption modes have an explicit nonce, whereas Xsalsa20Poly1305
         // has the nonce as the rtp header.
         if session_description.encryption_mode != VoiceEncryptionMode::Xsalsa20Poly1305 {
             encrypted_payload.append(&mut nonce_bytes);

src/voice/udp/handler.rs

@@ -42,9 +42,9 @@ pub struct UdpHandler {
 }
 
 impl UdpHandler {
-    /// Spawns a new udp handler and performs ip discovery.
+    /// Spawns a new UDP handler and performs IP discovery.
     ///
-    /// Mutates the given data_reference with the ip discovery data.
+    /// Mutates the given data_reference with the IP discovery data.
     pub async fn spawn(
         data_reference: Arc<RwLock<VoiceData>>,
         url: SocketAddr,
@@ -141,7 +141,7 @@ impl UdpHandler {
 
     /// The main listen task;
     ///
-    /// Receives udp messages and parses them.
+    /// Receives UDP messages and parses them.
     async fn listen_task(&mut self) {
         loop {
             // FIXME: is there a max size for these packets?
@@ -150,7 +150,7 @@ impl UdpHandler {
             // Update: see <https://stackoverflow.com/questions/58097580/rtp-packet-maximum-size>
             // > "The RTP standard does not set a maximum size.."
             //
-            // The theorhetical max for this buffer would be 1458 bytes, but that is imo
+            // The theoretical max for this buffer would be 1458 bytes, but that is imo
             // unreasonable to allocate for every message.
             let mut buf: Vec<u8> = vec![0; 512];
 

src/voice/udp/mod.rs

@@ -2,7 +2,7 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
-//! Defines the udp component of voice communications, sending and receiving raw rtp data.
+//! Defines the UDP component of voice communications, sending and receiving raw rtp data.
 
 /// See <https://discord-userdoccers.vercel.app/topics/voice-connections#voice-packet-structure>
 /// This always adds up to 12 bytes

src/voice/voice_data.rs

@@ -9,17 +9,17 @@ use crate::types::{SessionDescription, Snowflake, VoiceReady, VoiceServerUpdate}
 #[derive(Debug, Default)]
 /// Saves data shared between parts of the voice architecture;
 ///
-/// Struct used to give the Udp connection data received from the gateway.
+/// Struct used to give the UDP connection data received from the gateway.
 pub struct VoiceData {
     pub server_data: Option<VoiceServerUpdate>,
     pub ready_data: Option<VoiceReady>,
     pub session_description: Option<SessionDescription>,
     pub user_id: Snowflake,
     pub session_id: String,
-    /// The last sequence number we used, has to be incremeted by one every time we send a message
+    /// The last sequence number we used, has to be incremented by one every time we send a message
     pub last_sequence_number: u16,
     pub ip_discovery: Option<IpDiscovery>,
 
-    /// The last udp encryption nonce, if we are using an encryption mode with incremental nonces.
+    /// The last UDP encryption nonce, if we are using an encryption mode with incremental nonces.
     pub last_udp_encryption_nonce: Option<u32>,
 }