Struct 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,
    pub last_compared_frame: Option<Frame>,
    pub local_checksum: Option<u128>,
    pub remote_checksum: Option<u128>,
    pub checksums_match: Option<bool>,
}

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 calculated by Fortress Rollback.

kbps_sent: usize

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

local_frames_behind: i32

The number of frames Fortress Rollback 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.

last_compared_frame: Option<Frame>

The most recent frame for which checksums were compared between peers.

This is None if no checksum comparison has occurred yet (e.g., early in the session or if desync detection is disabled).

local_checksum: Option<u128>

The local checksum at last_compared_frame.

This is the checksum computed locally from the saved game state at that frame. Compare with remote_checksum to check for desync.

remote_checksum: Option<u128>

The remote checksum at last_compared_frame.

This is the checksum received from the remote peer for that frame. Compare with local_checksum to check for desync.

checksums_match: Option<bool>

Whether checksums matched at the most recently compared frame.

This is a convenience field derived from comparing local_checksum and remote_checksum. It is None if no comparison has occurred.

• Some(true) - Checksums match, peers are synchronized
• Some(false) - DESYNC DETECTED - game state has diverged
• None - No comparison available yet

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 duplicate 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 Display for NetworkStats

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

Formats the value using the given formatter.

impl Hash for NetworkStats

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for NetworkStats

fn eq(&self, other: &NetworkStats) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for NetworkStats

impl Eq for NetworkStats

impl StructuralPartialEq for NetworkStats