Struct ggrs::NetworkStats

pub struct NetworkStats {
    pub send_queue_len: usize,
    pub ping: u128,
    pub kbps_sent: usize,
    pub local_frames_behind: i32,
    pub remote_frames_behind: i32,
}

The NetworkStats struct contains statistics about the current session.

Fields

send_queue_len: usize

The length of the queue containing UDP packets which have not yet been acknowledged by the end client.
The length of the send queue is a rough indication of the quality of the connection. The longer the send queue, the higher the round-trip time between the clients. The send queue will also be longer than usual during high packet loss situations.

ping: u128

The roundtrip packet transmission time as calcuated by GGRS.

kbps_sent: usize

The estimated bandwidth used between the two clients, in kilobits per second.

local_frames_behind: i32

The number of frames GGRS calculates that the local client is behind the remote client at this instant in time.
For example, if at this instant the current game client is running frame 1002 and the remote game client is running frame 1009, this value will mostly likely roughly equal 7.

remote_frames_behind: i32

The same as local_frames_behind, but calculated from the perspective of the remote player.

Implementations

impl NetworkStats

pub fn new() -> Self

Creates a new NetworkStats instance with default values.

Trait Implementations

impl Clone for NetworkStats

fn clone(&self) -> NetworkStats

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NetworkStats

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

Formats the value using the given formatter.

impl Default for NetworkStats

fn default() -> NetworkStats

Returns the “default value” for a type.

impl Copy for NetworkStats