use std::{collections::VecDeque, time::Duration};
#[derive(Debug, Clone)]
pub struct RttWindow {
samples: VecDeque<Duration>,
capacity: usize,
}
impl RttWindow {
pub fn new(capacity: usize) -> Self {
Self {
samples: VecDeque::with_capacity(capacity),
capacity,
}
}
pub fn record(&mut self, rtt: Duration) {
if self.capacity == 0 {
return;
}
self.samples.push_back(rtt);
if self.samples.len() > self.capacity {
self.samples.pop_front();
}
}
pub fn is_empty(&self) -> bool {
self.samples.is_empty()
}
pub fn mean(&self) -> Option<Duration> {
if self.samples.is_empty() {
return None;
}
let sum: Duration = self.samples.iter().copied().sum();
Some(sum / self.samples.len() as u32)
}
pub fn jitter(&self) -> Option<Duration> {
if self.samples.len() < 2 {
return None;
}
let mut total = Duration::ZERO;
let mut previous = self.samples[0];
for ¤t in self.samples.iter().skip(1) {
total += current.abs_diff(previous);
previous = current;
}
Some(total / (self.samples.len() - 1) as u32)
}
pub fn suggest_timeout(&self, multiplier: f64, floor: Duration, ceiling: Duration) -> Duration {
let Some(mean) = self.mean() else {
return floor;
};
let jitter = self.jitter().unwrap_or(Duration::ZERO);
let margin = jitter.mul_f64(multiplier.max(0.0));
(mean + margin).clamp(floor, ceiling.max(floor))
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn empty_window_has_no_statistics() {
let window = RttWindow::new(5);
assert!(window.is_empty());
assert_eq!(window.mean(), None);
assert_eq!(window.jitter(), None);
}
#[test]
fn suggested_timeout_falls_back_to_floor_when_empty() {
let window = RttWindow::new(5);
let floor = Duration::from_millis(200);
let ceiling = Duration::from_millis(2000);
assert_eq!(window.suggest_timeout(4.0, floor, ceiling), floor);
}
#[test]
fn mean_and_jitter_match_manual_calculation() {
let mut window = RttWindow::new(5);
window.record(Duration::from_millis(100));
window.record(Duration::from_millis(120));
window.record(Duration::from_millis(110));
assert_eq!(window.mean(), Some(Duration::from_millis(110)));
assert_eq!(window.jitter(), Some(Duration::from_millis(15)));
}
#[test]
fn oldest_sample_is_evicted_beyond_capacity() {
let mut window = RttWindow::new(2);
window.record(Duration::from_millis(100));
window.record(Duration::from_millis(200));
window.record(Duration::from_millis(300));
assert_eq!(window.mean(), Some(Duration::from_millis(250)));
}
#[test]
fn suggested_timeout_is_clamped_to_the_ceiling() {
let mut window = RttWindow::new(5);
window.record(Duration::from_millis(5000));
let floor = Duration::from_millis(200);
let ceiling = Duration::from_millis(1000);
assert_eq!(window.suggest_timeout(4.0, floor, ceiling), ceiling);
}
#[test]
fn suggested_timeout_respects_the_floor_for_fast_stable_samples() {
let mut window = RttWindow::new(5);
window.record(Duration::from_millis(1));
window.record(Duration::from_millis(1));
let floor = Duration::from_millis(200);
let ceiling = Duration::from_millis(1000);
assert_eq!(window.suggest_timeout(4.0, floor, ceiling), floor);
}
#[test]
fn a_ceiling_below_the_floor_yields_the_floor_rather_than_panicking() {
let mut window = RttWindow::new(5);
window.record(Duration::from_millis(5));
window.record(Duration::from_millis(7));
let floor = Duration::from_secs(3);
let ceiling = Duration::from_millis(400);
assert_eq!(
window.suggest_timeout(4.0, floor, ceiling),
floor,
"the floor is the one of the two the protocol imposes, so it wins"
);
}
#[test]
fn crossed_bounds_are_survivable_before_any_sample_too() {
let window = RttWindow::new(5);
let floor = Duration::from_secs(3);
assert_eq!(
window.suggest_timeout(4.0, floor, Duration::from_millis(400)),
floor
);
}
#[test]
fn zero_capacity_window_never_stores_samples() {
let mut window = RttWindow::new(0);
window.record(Duration::from_millis(100));
assert!(window.is_empty());
}
}