Struct zelda::Config

pub struct Config {
    pub timeout: Duration,
    pub timeout_check_interval: Duration,
    pub event_capacity: usize,
    pub rtt_alpha: f32,
    pub rtt_queue_capacity: usize,
}

Fields

timeout: Duration

The amount of time without communication that can be passed before a client is considered disconnected.

timeout_check_interval: Duration

How often to check for timeouts of connections. Under the hood, this is done in a separate thread and will lock individual connections while checking.

event_capacity: usize

Number of incoming events the socket can hold before it blocks reading from the UDP-socket. If the capacity is reached the underlying receive buffer may also reach its capacity resulting in packets being dropped.

rtt_alpha: f32

Factor used for smoothing RTT, formula: ((1.0 - rtt_alpha) * previous_estimate) + (rtt_alpha * sample_rtt)

rtt_queue_capacity: usize

Capacity of the queue that records RTT, lower capacity can mean less measurements. Set this based on the send-rate of the client and server, and the expected maximum RTT.

Example: Given a symmetric send-rate of 60Hz and an expected maximum RTT of 1 second, we can expect there to be a maximum of 60 outstanding acknowledgements at any given time. Therefore we need the capacity to hold at least 60 acks in order to get accurate readings.

Methods

impl Config

pub fn default() -> Self

pub fn new(
    timeout: Duration,
    timeout_check_interval: Duration,
    event_capacity: usize,
    rtt_alpha: f32,
    rtt_queue_capacity: usize
) -> Self

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Config

impl Debug for Config

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

Formats the value using the given formatter.