Struct bones_framework::networking::PlayerNetworkStats

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

A schema-compatible wrapper for ggrs NetworkStats struct contains networking stats.

Fields

player_idx: usize

The idx of the player these stats are for. Included here for self-attesting/ease-of-access.

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 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 PlayerNetworkStats

pub fn from_ggrs_network_stats(player_idx: usize, stats: NetworkStats) -> Self

Creates a new PlayerNetworkStats from a player index and a ggrs NetworkStats.

Trait Implementations

impl Clone for PlayerNetworkStats

fn clone(&self) -> PlayerNetworkStats

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PlayerNetworkStats

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

Formats the value using the given formatter.

impl Default for PlayerNetworkStats

fn default() -> PlayerNetworkStats

Returns the “default value” for a type.

impl HasSchema for PlayerNetworkStats

fn schema() -> &'static Schema

Get this type’s [Schema].

fn register_schema()

Register this schema with the global schema registry.

fn cast<T>(this: &Self) -> &T

where T: HasSchema,

Cast a reference of this type to a reference of another type with the same memory layout.

fn try_cast<T>(this: &Self) -> Result<&T, SchemaMismatchError>

where T: HasSchema,

Cast a reference of this type to a reference of another type with the same memory layout.

fn cast_mut<T>(this: &mut Self) -> &mut T

where T: HasSchema,

Cast a mutable reference of this type to a reference of another type with the same memory layout.

fn try_cast_mut<T>(this: &mut Self) -> Result<&mut T, SchemaMismatchError>

where T: HasSchema,

Cast a mutable reference of this type to a reference of another type with the same memory layout.

fn as_schema_ref(&self) -> SchemaRef<'_>

where Self: Sized,

Converts a reference of T to a SchemaRef

fn as_schema_mut(&mut self) -> SchemaRefMut<'_>

where Self: Sized,

Converts a reference of T to a SchemaRefMut

impl Copy for PlayerNetworkStats