remotia-buffer-utils 0.1.3

Buffer management utilities of remotia, an open source framework for the development of remote rendering software in pure Rust
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

use std::{fmt::Debug, sync::Arc, time::Duration};

use async_trait::async_trait;

use crate::BytesMut;
use remotia_core::traits::{FrameProcessor, PullableFrameProperties};
use tokio::sync::{
    mpsc::{self, Receiver, Sender},
    Mutex,
};

pub struct BuffersPool<K: Copy> {
    slot_id: K,
    buffers_sender: Sender<BytesMut>,
    buffers_receiver: Arc<Mutex<Receiver<BytesMut>>>,
}

impl<K: Copy> BuffersPool<K> {
    pub async fn new(slot_id: K, pool_size: usize, buffer_size: usize) -> Self {
        let (sender, receiver) = mpsc::channel(pool_size);

        for _ in 0..pool_size {
            let buf = BytesMut::with_capacity(buffer_size);
            sender.send(buf).await.unwrap();
        }

        Self {
            slot_id,
            buffers_sender: sender,
            buffers_receiver: Arc::new(Mutex::new(receiver)),
        }
    }

    pub fn borrower(&self) -> BufferBorrower<K> {
        BufferBorrower {
            slot_id: self.slot_id,
            receiver: self.buffers_receiver.clone(),
            soft: false,
        }
    }

    pub fn redeemer(&self) -> BufferRedeemer<K> {
        BufferRedeemer {
            slot_id: self.slot_id.clone(),
            sender: self.buffers_sender.clone(),
            soft: false,
        }
    }
}

pub struct BufferBorrower<K> {
    slot_id: K,
    receiver: Arc<Mutex<Receiver<BytesMut>>>,
    soft: bool,
}

impl<K> BufferBorrower<K> {
    pub fn soft(mut self) -> Self {
        self.soft = true;
        self
    }
}

#[async_trait]
impl<F, K> FrameProcessor<F> for BufferBorrower<K>
where
    K: Copy + Debug + Send,
    F: PullableFrameProperties<K, BytesMut> + Send + 'static,
{
    async fn process(&mut self, mut frame_data: F) -> Option<F> {
        log::debug!("Borrowing '{:?}' buffer...", self.slot_id);

        loop {
            let mut receiver = self.receiver.lock().await;
            match receiver.try_recv() {
                Ok(buffer) => {
                    frame_data.push(self.slot_id, buffer);
                    break;
                }
                Err(err) => {
                    log::debug!("Unable to borrow '{:?}' buffer: {:?}", self.slot_id, err);
                    tokio::task::yield_now().await;
                    if self.soft {
                        break;
                    }
                }
            }
        }

        Some(frame_data)
    }
}

pub struct BufferRedeemer<K> {
    slot_id: K,
    sender: Sender<BytesMut>,
    soft: bool,
}

impl<K> BufferRedeemer<K> {
    pub fn soft(mut self) -> Self {
        self.soft = true;
        self
    }
}

#[async_trait]
impl<F, K> FrameProcessor<F> for BufferRedeemer<K>
where
    K: Copy + Debug + Send,
    F: PullableFrameProperties<K, BytesMut> + Send + 'static,
{
    async fn process(&mut self, mut frame_data: F) -> Option<F> {
        log::debug!(
            "Redeeming '{:?}' buffer (soft = {})...",
            self.slot_id,
            self.soft
        );

        let buffer = frame_data.pull(&self.slot_id);

        match buffer {
            Some(mut buffer) => {
                buffer.clear();

                self.sender
                    .send(buffer)
                    .await
                    .expect(&format!("Unable to redeem '{:?}' buffer", self.slot_id));

                if self.soft {
                    log::debug!("Soft-redeemed a '{:?}' buffer", self.slot_id);
                }
            }
            None => {
                if !self.soft {
                    panic!("Missing '{:?}' buffer", self.slot_id);
                }
            }
        }

        log::debug!(
            "Redeemed '{:?}' buffer (soft = {})",
            self.slot_id,
            self.soft
        );

        Some(frame_data)
    }
}