Lochnair-Labs/irtt-rs
2
0 Fork 0
Code Issues 1 Pull Requests 4 Actions 8 Packages Projects Releases 6 Wiki Activity

docs(client): clarify terminal open replies

Browse Source
This commit is contained in:
Nils Andreas Svee committed 2026-09-15 12:31:45 +07:00
1 parent 2882beb2c9
commit 188d6e5354
1 file changed
+6 -5
Download Patch File Download Diff File Expand all files Collapse all files
crates/irtt-client/src/client.rs
+6 -5
View File
@@ -163,12 +163,13 @@ impl Client {
/// ///
/// On success, returns the negotiated open outcome and transitions the /// On success, returns the negotiated open outcome and transitions the
/// client into either an open probe session or completed no-test state. /// client into either an open probe session or completed no-test state.
/// Open attempts use [`ClientConfig::open_timeouts`]. Malformed, unrelated, /// Open attempts use [`ClientConfig::open_timeouts`]. Malformed or
/// or unauthenticated datagrams are ignored until the current attempt's /// unrelated datagrams are ignored until the current attempt's absolute
/// absolute deadline, so one attempt may consume several datagrams without /// deadline, so one attempt may consume several datagrams without
/// retransmitting. Silence or ignored traffic eventually produces /// retransmitting. Silence or ignored traffic eventually produces
/// [`ClientError::OpenTimeout`], while authenticated incompatibility remains /// [`ClientError::OpenTimeout`]. A malformed or incompatible reply that is
/// terminal. /// 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 /// When a trusted reply allocates a token but later negotiation or socket
/// preparation fails, the client sends a best-effort cleanup close and /// preparation fails, the client sends a best-effort cleanup close and