Skip to main content

ClientMetrics

Struct ClientMetrics 

Source
pub struct ClientMetrics {
    pub average_processing_time_ms: f64,
    pub frames_acknowledged: u32,
    pub last_ack_time: Option<Instant>,
    pub estimated_bandwidth_kbps: Option<f64>,
    pub connection_rtt_ms: Option<u64>,
}
Expand description

Client performance metrics for adaptive streaming

Fields§

§average_processing_time_ms: f64

Exponential moving average of client frame-processing time, in milliseconds.

§frames_acknowledged: u32

Number of frames the client has acknowledged.

§last_ack_time: Option<Instant>

Instant of the most recent acknowledgement, if any.

§estimated_bandwidth_kbps: Option<f64>

Estimated downlink bandwidth, in kilobits per second, if measured.

§connection_rtt_ms: Option<u64>

Round-trip time of the WebSocket connection, in milliseconds, if measured.

Implementations§

Source§

impl ClientMetrics

Source

pub fn update_processing_time(&mut self, processing_time_ms: u64)

Fold a new processing-time observation into the moving average.

Source

pub fn is_client_slow(&self) -> bool

Returns true when average client processing time exceeds the slow-client threshold.

Source

pub fn recommended_frame_delay(&self) -> Duration

Recommended delay between frames given the current processing-time average.

Clamped to MAX_ADAPTIVE_FRAME_DELAY: average_processing_time_ms is derived from client-supplied processing_time_ms in Self::update_processing_time, which is unvalidated wire input (see handle_frame_ack). Without a ceiling, a single malicious FrameAck could drive the tokio::time::sleep in AdaptiveStreamController::stream_frames to an arbitrarily long duration and stall that session’s stream.

Trait Implementations§

Source§

impl Debug for ClientMetrics

Source§

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

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

impl Default for ClientMetrics

Source§

fn default() -> ClientMetrics

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more