vidaptive 0.1.0

Responsive rate control for real-time video
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

//! Pluggable congestion controllers.

mod copa;
mod noop;

pub use copa::{Copa, CopaConfig};
pub use noop::NoopCc;

use core::time::Duration;

use crate::types::{AckInfo, LostPacket, SentPacket};

/// Bandwidth estimator
pub trait CongestionController {
    /// Notify the CC that a packet was sent.
    fn on_packet_sent(&mut self, packet: &SentPacket);

    /// Notify the CC that a packet was acknowledged.
    fn on_packet_acked(&mut self, ack: &AckInfo) {
        self.on_packets_acked(core::slice::from_ref(ack));
    }

    /// Notify the CC of one or more ACKs in a single feedback event.
    fn on_packets_acked(&mut self, acks: &[AckInfo]);

    /// Notify the CC that a packet was lost.
    fn on_packet_lost(&mut self, packet: &LostPacket);

    /// Smoothed sending rate estimate (`CC-Rate`) in bytes per second.
    fn pacing_rate(&self) -> u64;

    /// Congestion window in bytes.
    fn cwnd(&self) -> u64;

    /// Smoothed round-trip time.
    fn rtt(&self) -> Duration;

    /// Whether another `len`-byte packet may be sent given current bytes in flight.
    fn can_send(&self, bytes_in_flight: u64) -> bool;
}