quickie 0.7.0

A simple, low-level, and customizable implementation of a QUIC P2P node.
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

use std::{
    io,
    sync::atomic::{AtomicU64, Ordering::Relaxed},
};

use bytes::BytesMut;
use futures_util::SinkExt;
use tokio::io::AsyncWrite;
use tokio_util::codec::{Decoder, Encoder, FramedWrite};

/// A wrapper [`Decoder`] that also counts the bytes belonging to the inbound messages.
pub(crate) struct CountingDecoder<D: Decoder> {
    decoder: D,
    acc: usize,
}

impl<D: Decoder> CountingDecoder<D> {
    pub(crate) fn new(decoder: D) -> Self {
        Self { decoder, acc: 0 }
    }
}

impl<D: Decoder> Decoder for CountingDecoder<D> {
    type Item = (D::Item, usize);
    type Error = D::Error;

    fn decode(&mut self, src: &mut BytesMut) -> Result<Option<Self::Item>, Self::Error> {
        let initial_buf_len = src.len();
        let ret = self.decoder.decode(src)?;
        let final_buf_len = src.len();
        let read_len = initial_buf_len - final_buf_len + self.acc;

        if read_len != 0 {
            if let Some(item) = ret {
                self.acc = 0;

                Ok(Some((item, read_len)))
            } else {
                self.acc = read_len;

                Ok(None)
            }
        } else {
            Ok(None)
        }
    }
}

/// A helper function counting the bytes written to a `FramedWrite`.
pub(crate) async fn counting_send<
    T: Send,
    W: AsyncWrite + Unpin,
    E: Encoder<T, Error = io::Error>,
>(
    framed: &mut FramedWrite<W, E>,
    item: T,
) -> io::Result<usize> {
    framed.feed(item).await?;
    let len = framed.write_buffer().len();
    framed.flush().await?;
    Ok(len)
}

/// The internal representation of a stream's stats.
#[derive(Default)]
pub(crate) struct StreamStatsInner {
    /// The number of all messages sent.
    msgs_sent: AtomicU64,
    /// The number of all messages received.
    msgs_recv: AtomicU64,
    /// The number of all bytes sent.
    bytes_sent: AtomicU64,
    /// The number of all bytes received.
    bytes_recv: AtomicU64,
}

impl StreamStatsInner {
    pub(crate) fn register_msg_rx(&self, size: usize) {
        self.msgs_recv.fetch_add(1, Relaxed);
        self.bytes_recv.fetch_add(size as u64, Relaxed);
    }

    pub(crate) fn register_msg_tx(&self, size: usize) {
        self.msgs_sent.fetch_add(1, Relaxed);
        self.bytes_sent.fetch_add(size as u64, Relaxed);
    }

    pub(crate) fn get_stats(&self) -> StreamStats {
        StreamStats {
            msgs_sent: self.msgs_sent.load(Relaxed),
            msgs_recv: self.msgs_recv.load(Relaxed),
            bytes_sent: self.bytes_sent.load(Relaxed),
            bytes_recv: self.bytes_recv.load(Relaxed),
        }
    }
}

// TODO: rename to something else, now that datagram stats are collected too.
/// A set of simple statistics related to a stream.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct StreamStats {
    /// The number of all messages sent.
    pub msgs_sent: u64,
    /// The number of all messages received.
    pub msgs_recv: u64,
    /// The number of all bytes sent.
    pub bytes_sent: u64,
    /// The number of all bytes received.
    pub bytes_recv: u64,
}