Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify units for statistics #374

Merged
merged 1 commit into from
Dec 2, 2024
Merged

Clarify units for statistics #374

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/client/diagnostics.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ impl Plugin for ClientDiagnosticsPlugin {
)
.register_diagnostic(
Diagnostic::new(Self::RTT)
.with_suffix(" ms")
.with_suffix(" s")
.with_max_history_length(Self::DIAGNOSTIC_HISTORY_LEN),
)
.register_diagnostic(
Expand Down
8 changes: 4 additions & 4 deletions src/core/connected_clients.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,14 +57,14 @@ impl ConnectedClient {
self.id
}

/// Returns the round-time trip for the connection.
/// Returns the round-time trip in seconds for the connection.
///
/// Returns zero if not provided by the backend.
pub fn rtt(&self) -> f64 {
self.rtt
}

/// Sets the round-time trip for the connection.
/// Sets the round-time trip in seconds for the connection.
///
/// <div class="warning">
///
Expand All @@ -75,14 +75,14 @@ impl ConnectedClient {
self.rtt = rtt;
}

/// Returns the packet loss for the connection.
/// Returns the packet loss % for the connection.
///
/// Returns zero if not provided by the backend.
pub fn packet_loss(&self) -> f64 {
self.packet_loss
}

/// Sets the packet loss for the connection.
/// Sets the packet loss % for the connection.
///
/// <div class="warning">
///
Expand Down
8 changes: 4 additions & 4 deletions src/core/replicon_client.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,14 +211,14 @@ impl RepliconClient {
channel_messages.push(message.into());
}

/// Returns the round-time trip for the connection.
/// Returns the round-time trip in seconds for the connection.
///
/// Returns zero if not provided by the backend.
pub fn rtt(&self) -> f64 {
self.rtt
}

/// Sets the round-time trip for the connection.
/// Sets the round-time trip in seconds for the connection.
///
/// <div class="warning">
///
Expand All @@ -229,14 +229,14 @@ impl RepliconClient {
self.rtt = rtt;
}

/// Returns the packet loss for the connection.
/// Returns the packet loss % for the connection.
///
/// Returns zero if not provided by the backend.
pub fn packet_loss(&self) -> f64 {
self.packet_loss
}

/// Sets the packet loss for the connection.
/// Sets the packet loss % for the connection.
///
/// <div class="warning">
///
Expand Down
Loading