docs(readme): document handshake blocking and widen fuzz timeout

commit: c65691c6de9b7757bd565e4d83d67e7cf8bb7cb3
author: brice · 9h ago · 2026-10-22 10:41 UTC
parent: 1bfe747
signature: GPG VerifiedCD88F9E564E0102646FB6077A1A07C7C7C3E349D · arch-gpg Verified for the committer email
checks: 1/2

2 files · +4 -3

M .github/workflows/fuzz.yml +1 -1

M README.md +3 -2


@@ -129,8 +129,9 @@ func Example() {
129	129		- Callbacks. They may queue requests, call `Expect` and `PrefetchXIDs`.
130	130		They must not call `Dispatch`, `Sync`, `InternAtoms`, or `NewXID` when it
131	131		needs a refill.
132		-	- Blocking. Only `Sync`, `InternAtoms` and a `NewXID` refill block, for at
133		-	most 5 s, and are meant for startup. Use `XIDsLow` and `PrefetchXIDs` to
	132	+	- Blocking. `Dial` and `NewConn` block for at most 10 s during the
	133	+	handshake. Only `Sync`, `InternAtoms` and a `NewXID` refill block after
	134	+	that, for at most 5 s, and are meant for startup. Use `XIDsLow` and `PrefetchXIDs` to
134	135		keep the event loop non-blocking.
135	136		- Errors. A failed `Buf` is sticky: later requests return 0 and `Flush`
136	137		returns the error.

 - **Callbacks.** They may queue requests, call `Expect` and `PrefetchXIDs`.
   They must not call `Dispatch`, `Sync`, `InternAtoms`, or `NewXID` when it
   needs a refill.
-- **Blocking.** Only `Sync`, `InternAtoms` and a `NewXID` refill block, for at
+- **Blocking.** `Dial` and `NewConn` block for at most 10 s during the
-  most 5 s, and are meant for startup. Use `XIDsLow` and `PrefetchXIDs` to
+  handshake. Only `Sync`, `InternAtoms` and a `NewXID` refill block after
+  that, for at most 5 s, and are meant for startup. Use `XIDsLow` and `PrefetchXIDs` to
   keep the event loop non-blocking.
 - **Errors.** A failed `Buf` is sticky: later requests return 0 and `Flush`
   returns the error.