Skip to main content

CodeSwitchController

Struct CodeSwitchController 

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

Immediate-up / conservative-down controller that turns a stream of fed-back loss_q8 samples into code-switch decisions under a CodePolicy.

Up-switches (to the stronger high-loss RS code) fire the instant the loss sustains above the up threshold for up_hold samples; down-switches (back to RLC) require down_hold sustained-below samples, a longer streak, so a brief lull does not strip the stronger code while loss is still bursty.

Implementations§

Source§

impl CodeSwitchController

Source

pub fn new(policy: CodePolicy, up_hold: u32, down_hold: u32) -> Self

A controller under policy, starting on the policy’s initial code. up_hold consecutive over-threshold samples confirm an up-switch; down_hold (typically larger) under-threshold samples confirm the relax back to RLC.

Source

pub fn with_policy(policy: CodePolicy) -> Self

A controller with sensible default holds: an up-switch confirms in 3 feedback intervals (loss spiked and held, robust to window noise), a down-switch in 8 (loss must stay low a while before dropping the stronger code).

Source

pub fn code(&self) -> SensCode

The code currently selected.

Source

pub fn switches(&self) -> u64

Total confirmed code switches so far (telemetry).

Source

pub fn observe(&mut self, loss_q8: u8) -> Option<SensCode>

Feed one fed-back forward-loss sample (loss_q8 = loss * 256). Returns Some(new_code) exactly on the sample that confirms a switch, else None. A forced policy never switches.

Source

pub fn force(&mut self, to: SensCode) -> bool

Align the controller to to for a switch driven OUTSIDE observe (the flow-block escape), counting it and resetting the hysteresis streaks so the band restarts from the new code. Returns whether it switched: a forced policy stays put (returns false), as does an already-on-to controller.

Trait Implementations§

Source§

impl Clone for CodeSwitchController

Source§

fn clone(&self) -> CodeSwitchController

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 Debug for CodeSwitchController

Source§

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

Formats the value using the given formatter. 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 = Infallible

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.