Struct naia_shared::LinkConditionerConfig

pub struct LinkConditionerConfig {
    pub incoming_latency: u32,
    pub incoming_jitter: u32,
    pub incoming_loss: f32,
}

Contains configuration required to initialize a LinkConditioner

Fields

incoming_latency: u32

Delay to receive incoming messages in milliseconds

incoming_jitter: u32

The maximum additional random latency to delay received incoming messages in milliseconds. This may be added OR subtracted from the latency determined in the incoming_latency property above

incoming_loss: f32

The % chance that an incoming packet will be dropped. Represented as a value between 0 and 1

Implementations

impl LinkConditionerConfig

pub fn new(
    incoming_latency: u32,
    incoming_jitter: u32,
    incoming_loss: f32
) -> LinkConditionerConfig

Creates a new LinkConditionerConfig

pub fn good_condition() -> LinkConditionerConfig

Creates a new LinkConditioner that simulates a connection which is in a good condition

pub fn average_condition() -> LinkConditionerConfig

Creates a new LinkConditioner that simulates a connection which is in an average condition

pub fn poor_condition() -> LinkConditionerConfig

Creates a new LinkConditioner that simulates a connection which is in an poor condition

Trait Implementations

impl Clone for LinkConditionerConfig

fn clone(&self) -> LinkConditionerConfig

Returns a copy of the value.

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

Performs copy-assignment from source.