tunneler-core 0.11.0

Provides the Core functionality for the Tunneler software
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

use std::sync::Arc;

use crate::{
    client::QueueSender,
    message::Message,
    streams::{error::RecvError, mpsc},
    Details,
};

use async_trait::async_trait;

use super::queues;

/// A Generic trait that abstracts over the actual receiving
/// type and implementation allowing you to easily mock it
/// and also allows for more versitility when using this in
/// general as well as giving more freedom to the underlying
/// types
#[async_trait]
pub trait Receiver {
    /// Receives a single Message over the Connection
    async fn recv_msg(&mut self) -> Result<Message, RecvError>;
}

/// A Generic trait that abstract away the actual underlying
/// type and implementation for sending Data back to the
/// User over that connection
#[async_trait]
pub trait Sender {
    /// Sends a single Message over the Connection
    async fn send_msg(&self, data: Vec<u8>, length: u64) -> bool;
}

#[async_trait]
impl Receiver for mpsc::StreamReader<Message> {
    async fn recv_msg(&mut self) -> Result<Message, RecvError> {
        self.recv().await
    }
}

#[async_trait]
impl Sender for queues::Sender {
    async fn send_msg(&self, data: Vec<u8>, length: u64) -> bool {
        self.send(data, length).await
    }
}

/// This defines a single Handler that will receive every new Connection
/// that is established
#[async_trait]
pub trait Handler {
    /// This method is called every time a new Connection is received and
    /// should therefore handle all the initial stuff for dealing with
    /// the new Connection
    async fn new_con(
        self: Arc<Self>,
        id: u32,
        details: Details,
        rx: mpsc::StreamReader<Message>,
        tx: QueueSender,
    );
}