From 188d6e53541722a608805491117851ed97133cad Mon Sep 17 00:00:00 2001 From: Nils Andreas Svee Date: Tue, 15 Sep 2026 12:31:45 +0700 Subject: [PATCH] docs(client): clarify terminal open replies --- crates/irtt-client/src/client.rs | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/crates/irtt-client/src/client.rs b/crates/irtt-client/src/client.rs index 3ada7f5..ceee7a9 100644 --- a/crates/irtt-client/src/client.rs +++ b/crates/irtt-client/src/client.rs @@ -163,12 +163,13 @@ impl Client { /// /// On success, returns the negotiated open outcome and transitions the /// client into either an open probe session or completed no-test state. - /// Open attempts use [`ClientConfig::open_timeouts`]. Malformed, unrelated, - /// or unauthenticated datagrams are ignored until the current attempt's - /// absolute deadline, so one attempt may consume several datagrams without + /// Open attempts use [`ClientConfig::open_timeouts`]. Malformed or + /// unrelated datagrams are ignored until the current attempt's absolute + /// deadline, so one attempt may consume several datagrams without /// retransmitting. Silence or ignored traffic eventually produces - /// [`ClientError::OpenTimeout`], while authenticated incompatibility remains - /// terminal. + /// [`ClientError::OpenTimeout`]. A malformed or incompatible reply that is + /// recognized as coming from the connected peer is terminal; when HMAC is + /// configured, that recognition additionally requires authentication. /// /// When a trusted reply allocates a token but later negotiation or socket /// preparation fails, the client sends a best-effort cleanup close and