flute 1.11.0

File Delivery over Unidirectional Transport (FLUTE)
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

use super::blockencoder::BlockEncoder;
use super::fdt::Fdt;
use super::filedesc::FileDesc;
#[cfg(feature = "opentelemetry")]
use super::objectsenderlogger::ObjectSenderLogger;
use super::Profile;
use crate::common::alc;
use crate::core::UDPEndpoint;
use std::sync::Arc;
use std::time::SystemTime;

#[allow(dead_code)]
#[derive(Debug)]
pub struct SenderSession {
    priority: u32,
    endpoint: UDPEndpoint,
    tsi: u64,
    file: Option<Arc<FileDesc>>,
    encoder: Option<BlockEncoder>,
    interleave_blocks: usize,
    transfer_fdt_only: bool,
    profile: Profile,
    #[cfg(feature = "opentelemetry")]
    logger: Option<ObjectSenderLogger>,
}

impl SenderSession {
    pub fn new(
        priority: u32,
        tsi: u64,
        interleave_blocks: usize,
        transfer_fdt_only: bool,
        profile: Profile,
        endpoint: UDPEndpoint,
    ) -> SenderSession {
        SenderSession {
            priority,
            endpoint,
            tsi,
            file: None,
            encoder: None,
            interleave_blocks,
            transfer_fdt_only,
            profile,
            #[cfg(feature = "opentelemetry")]
            logger: None,
        }
    }

    pub fn run(&mut self, fdt: &mut Fdt, now: SystemTime) -> Option<Vec<u8>> {
        loop {
            if self.encoder.is_none() {
                self.get_next(fdt, now);
            }

            if !self.transfer_fdt_only {
                // Stop emitting packets if a new FDT is needed
                if fdt.need_transfer_fdt() {
                    return None;
                }
            }

            let encoder = self.encoder.as_mut()?;

            debug_assert!(self.file.is_some());
            let file = self.file.as_ref().unwrap();
            let must_stop_transfer = !self.transfer_fdt_only
                && file.can_transfer_be_stopped()
                && !fdt.is_added(file.toi);

            if must_stop_transfer {
                log::debug!("File has already been transferred and is removed from the FDT, stop the transfer {}", file.object.content_location.to_string());
            }

            if let Some(next_timestamp) = file.get_next_transfer_timestamp() {
                if next_timestamp > now {
                    return None;
                }
            }

            let pkt = encoder.read(must_stop_transfer);
            if pkt.is_none() {
                self.release_file(fdt, now);
                continue;
            }

            file.inc_next_transfer_timestamp();
            let pkt = pkt.as_ref().unwrap();
            return Some(alc::new_alc_pkt(
                &file.oti,
                &0u128,
                self.tsi,
                pkt,
                self.profile,
                now,
            ));
        }
    }

    fn get_next(&mut self, fdt: &mut Fdt, now: SystemTime) {
        self.encoder = None;
        if self.transfer_fdt_only {
            self.file = fdt.get_next_fdt_transfer(now);
        } else {
            self.file = fdt.get_next_file_transfer(self.priority, now);
        }
        if self.file.is_none() {
            return;
        }

        #[cfg(feature = "opentelemetry")]
        if !self.transfer_fdt_only {
            let file = self.file.as_ref().unwrap();
            if file.total_nb_transfer() == 0 {
                self.logger = Some(ObjectSenderLogger::new(
                    &self.endpoint,
                    self.tsi,
                    file.toi,
                    file.object.config.optel_propagator.as_ref(),
                ));
            }
        }

        let file = self.file.as_ref().unwrap().clone();
        let is_last_transfer = file.is_last_transfer();
        let block_encoder = BlockEncoder::new(file, self.interleave_blocks, is_last_transfer);
        if block_encoder.is_err() {
            log::error!("Fail to open Block Encoder");
            self.release_file(fdt, now);
            return;
        }

        self.encoder = block_encoder.ok();
    }

    fn release_file(&mut self, fdt: &mut Fdt, now: SystemTime) {
        if let Some(file) = &self.file {
            fdt.transfer_done(file.clone(), now)
        };

        self.file = None;
        self.encoder = None;

        #[cfg(feature = "opentelemetry")]
        {
            self.logger = None;
        }
    }
}