docs: document Linux kernel-timestamp preference for OWD

On Linux, one-way delay measurement best-effort prefers kernel
send/receive timestamps over userspace timing, falling back
whenever a kernel reading is unavailable or implausible. RTT is
unaffected and remains userspace-timed.

Add a user-facing README note near the measurement/output
explanation, and bring OneWayDelaySample::client_to_server's
rustdoc in line with the send-endpoint behavior, matching the
style already used for server_to_client. Also fix a stale
socket_io module doc that still claimed the captured kernel
receive timestamp went unconsumed; ServerCore has used it via
preferred_receive_wall_ns since d3f93a9.
This commit is contained in:
Nils Andreas Svee committed 2026-08-20 14:56:50 +07:00
1 parent 1ce65c0db4
commit 13a907bc28
3 files changed
+14 -6

No files matched your search

+7 -1
View File
@@ -351,7 +351,13 @@ pub struct OneWayDelaySample {
/// Client-to-server delay.
///
/// This is computed from the client send wall time and the server receive
/// wall time when both are available.
/// wall time when both are available. The client send endpoint is the
/// correlated Linux kernel TX timestamp for this send when one is
/// available and plausible for this send, and the userspace post-send wall
/// time otherwise. The server receive endpoint is the server's kernel
/// receive timestamp when one is available and plausible, and its
/// userspace receive wall time otherwise. RTT is unaffected and remains a
/// userspace monotonic measurement.
pub client_to_server: Option<SignedDuration>,
/// Server-to-client delay.
///