Skip to main content

OveruseDetector

Struct OveruseDetector 

Source
pub struct OveruseDetector { /* private fields */ }
Expand description

Turns a filtered delay trend into a Usage, with hysteresis.

§Why the debounce

The trend crossing the threshold once means very little — the filter is still noisy, and a single video frame arriving late will do it. Overuse is only declared when the trend stays outside and has not decreased since the last reading and at least two readings agree. Upstream does the same (overuse_detector.go); it is what stops the estimate sawtoothing.

Coming back has no such delay: Normal and Under are declared immediately, because being slow to notice that a path has recovered wastes capacity for as long as it takes to notice.

Implementations§

Source§

impl OveruseDetector

Source

pub fn new() -> Self

A detector with the draft’s tuning.

Source

pub fn usage(&self) -> Usage

What the detector currently believes.

Source

pub fn threshold_ms(&self) -> f64

The threshold the trend is being compared against, in milliseconds.

Source

pub fn update(&mut self, now: Instant, estimate_ms: f64) -> Usage

Fold in one filtered trend reading and return the resulting usage.

estimate_ms is the kalman-filtered delay gradient; now is when it was measured.

Trait Implementations§

Source§

impl Clone for OveruseDetector

Source§

fn clone(&self) -> OveruseDetector

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for OveruseDetector

Source§

impl Debug for OveruseDetector

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for OveruseDetector

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.