Fix timing bugs and add documentation

[m17rt] / m17app / src / app.rs

diff --git a/m17app/src/app.rs b/m17app/src/app.rs
index b1426638e28e1dd4a3dcef0d1ec96c5cbd2db5a9..7f17df64a4f5898ba1de7cff2b0b364484f7bc55 100644 (file)
--- a/m17app/src/app.rs
+++ b/m17app/src/app.rs
@@ -1,7 +1,9 @@
 use crate::adapter::{PacketAdapter, StreamAdapter};
 use crate::adapter::{PacketAdapter, StreamAdapter};

+use crate::link_setup::LinkSetup;

 use crate::tnc::Tnc;
 use crate::tnc::Tnc;

+use crate::{LsfFrame, PacketType, StreamFrame};

 use m17core::kiss::{KissBuffer, KissCommand, KissFrame};
 use m17core::kiss::{KissBuffer, KissCommand, KissFrame};

-use m17core::protocol::{EncryptionType, LsfFrame, PacketType, StreamFrame};
+use m17core::protocol::EncryptionType;

 
 use log::debug;
 use std::collections::HashMap;
 
 use log::debug;
 use std::collections::HashMap;


@@ -83,27 +85,30 @@ pub struct TxHandle {
 }
 
 impl TxHandle {
 }
 
 impl TxHandle {

-    pub fn transmit_packet(&self, packet_type: PacketType, payload: &[u8]) {
-        // hang on where do we get the LSF details from? We need a destination obviously
-        // our source address needs to be configured here too
-        // also there is possible CAN, encryption, meta payload
-
-        // we will immediately convert this into a KISS payload before sending into channel so we only need borrow on data
+    pub fn transmit_packet(&self, link_setup: &LinkSetup, packet_type: PacketType, payload: &[u8]) {
+        let (pack_type, pack_type_len) = packet_type.as_proto();
+        if pack_type_len + payload.len() > 823 {
+            // TODO: error for invalid transmission type
+            return;
+        }
+        let mut full_payload = vec![];
+        full_payload.extend_from_slice(&pack_type[0..pack_type_len]);
+        full_payload.extend_from_slice(payload);
+        let crc = m17core::crc::m17_crc(&full_payload);
+        full_payload.extend_from_slice(&crc.to_be_bytes());
+        let kiss_frame = KissFrame::new_full_packet(&link_setup.raw.0, &full_payload).unwrap();
+        let _ = self.event_tx.send(TncControlEvent::Kiss(kiss_frame));

     }
 
     }
 

-    // add more methods here for stream outgoing
-
-    pub fn transmit_stream_start(&self, lsf: LsfFrame) {
-        // TODO: is asking for an LsfFrame a good idea or unfriendly API?
-        // What I should do here is create a LinkSetup struct which wraps an LsfFrame and can be loaded with a raw one
-        let kiss_frame = KissFrame::new_stream_setup(&lsf.0).unwrap();
+    pub fn transmit_stream_start(&self, link_setup: &LinkSetup) {
+        let kiss_frame = KissFrame::new_stream_setup(&link_setup.raw.0).unwrap();

         let _ = self.event_tx.send(TncControlEvent::Kiss(kiss_frame));
     }
 
     // as long as there is only one TNC it is implied there is only ever one stream transmission in flight
 
         let _ = self.event_tx.send(TncControlEvent::Kiss(kiss_frame));
     }
 
     // as long as there is only one TNC it is implied there is only ever one stream transmission in flight
 

-    pub fn transmit_stream_next(&self, stream: StreamFrame) {
-        let kiss_frame = KissFrame::new_stream_data(&stream).unwrap();
+    pub fn transmit_stream_next(&self, stream: &StreamFrame) {
+        let kiss_frame = KissFrame::new_stream_data(stream).unwrap();

         let _ = self.event_tx.send(TncControlEvent::Kiss(kiss_frame));
     }
 }
         let _ = self.event_tx.send(TncControlEvent::Kiss(kiss_frame));
     }
 }


@@ -129,6 +134,7 @@ impl Adapters {
 }
 
 /// Carries a request from a method on M17App to the TNC's writer thread, which will execute it.
 }
 
 /// Carries a request from a method on M17App to the TNC's writer thread, which will execute it.

+#[allow(clippy::large_enum_variant)]

 enum TncControlEvent {
     Kiss(KissFrame),
     Start,
 enum TncControlEvent {
     Kiss(KissFrame),
     Start,


@@ -140,8 +146,8 @@ fn spawn_reader<T: Tnc>(mut tnc: T, adapters: Arc<RwLock<Adapters>>) {
         let mut kiss_buffer = KissBuffer::new();
         let mut stream_running = false;
         loop {
         let mut kiss_buffer = KissBuffer::new();
         let mut stream_running = false;
         loop {

-            let mut buf = kiss_buffer.buf_remaining();
-            let n = match tnc.read(&mut buf) {
+            let buf = kiss_buffer.buf_remaining();
+            let n = match tnc.read(buf) {

                 Ok(n) => n,
                 Err(_) => break,
             };
                 Ok(n) => n,
                 Err(_) => break,
             };


@@ -195,8 +201,8 @@ fn spawn_reader<T: Tnc>(mut tnc: T, adapters: Arc<RwLock<Adapters>>) {
                             adapters.read().unwrap().packet.values().cloned().collect();
                         for s in subs {
                             s.packet_received(
                             adapters.read().unwrap().packet.values().cloned().collect();
                         for s in subs {
                             s.packet_received(

-                                lsf.clone(),
-                                packet_type.clone(),
+                                LinkSetup::new_raw(lsf.clone()),
+                                packet_type,

                                 packet_payload.clone(),
                             );
                         }
                                 packet_payload.clone(),
                             );
                         }


@@ -217,7 +223,7 @@ fn spawn_reader<T: Tnc>(mut tnc: T, adapters: Arc<RwLock<Adapters>>) {
                             let subs: Vec<_> =
                                 adapters.read().unwrap().stream.values().cloned().collect();
                             for s in subs {
                             let subs: Vec<_> =
                                 adapters.read().unwrap().stream.values().cloned().collect();
                             for s in subs {

-                                s.stream_began(lsf.clone());
+                                s.stream_began(LinkSetup::new_raw(lsf.clone()));

                             }
                         } else if n == 26 {
                             if !stream_running {
                             }
                         } else if n == 26 {
                             if !stream_running {


@@ -256,7 +262,7 @@ fn spawn_writer<T: Tnc>(mut tnc: T, event_rx: mpsc::Receiver<TncControlEvent>) {
         while let Ok(ev) = event_rx.recv() {
             match ev {
                 TncControlEvent::Kiss(k) => {
         while let Ok(ev) = event_rx.recv() {
             match ev {
                 TncControlEvent::Kiss(k) => {

-                    if let Err(e) = tnc.write_all(&k.as_bytes()) {
+                    if let Err(e) = tnc.write_all(k.as_bytes()) {

                         debug!("kiss send err: {:?}", e);
                         return;
                     }
                         debug!("kiss send err: {:?}", e);
                         return;
                     }